com.adobe.forms.foundation.cloudconfig.IConfMeta Maven / Gradle / Ivy

Go to download
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2017 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/

package com.adobe.forms.foundation.cloudconfig;


import java.util.Calendar;
import java.util.Set;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.osgi.annotation.versioning.ProviderType;

/**
 * Represents an FDM configuration item from {@code /conf}.
 * 
 * The configuration might be of type {@code sling:Folder} or cq:Page
 *
 * 
 */
@ProviderType
public interface IConfMeta {

    /**
     * Returns the title of the item.
     *
     * @return Item title or resource name if none found. Returns never
     *         {@code null}
     */
    @Nonnull
    String getTitle();

    /**
     * Indicates if item has children.
     *
     * @return {@code true} if item has children
     */
    @Nonnull
    boolean hasChildren();

    /**
     * Returns the last modified time stamp.
     *
     * @return Last modified time in milliseconds or {@code null}
     */
    @Nullable
    Calendar getLastModifiedDate();

    /**
     * Returns the user which last modified the item
     *
     * @return User identifier or {@code null}
     */
    @Nullable
    String getLastModifiedBy();

    /**
     * Returns the last published time stamp.
     *
     * @return Last published time in milliseconds or {@code null}
     */
    @Nonnull
    Set getQuickactionsRels();

}