com.adobe.aemds.guide.common.FDField 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.aemds.guide.common;


import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.osgi.annotation.versioning.ConsumerType;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.jcr.RepositoryException;

/**
 * Defines the {@code Text} Sling Model for the forms & Documents component.
 */
@ConsumerType
@JsonInclude(JsonInclude.Include.NON_NULL)
public interface FDField {

    /**
     * @return Returns the title of the component.
     */
    @Nonnull
    @JsonProperty("title")
    String getTitle();

    /**
     * @return Returns the name of the component
     */
    @Nonnull
    @JsonProperty("name")
    String getName();

    /**
     * @return Returns the description of the component
     */
    @Nullable
    @JsonProperty("description")
    String getDescription();

    /**
     * @return Returns the type of the forms and documents component
     */
    @Nonnull
    @JsonProperty("fieldType")
    String getGuideFieldType();

    /**
     * @return Returns the id of the component.
     */
    @Nonnull
    @JsonProperty("id")
    String getId() throws RepositoryException;

    /**
     * @return Returns the path of the component.
     */
    @Nonnull
    String getPath();

    String getAuthoringConfigJSON();

}