Package com.adobe.cq.forms.core.components.models.form

Interface FormContainer

  • All Superinterfaces:
    com.adobe.cq.export.json.ComponentExporter, Container, com.adobe.cq.export.json.ContainerExporter
    @ConsumerType
public interface FormContainer
extends Container
    Defines the form container FormContainer Sling Model used for the /apps/core/fd/components/form/formcontainer component.
    Since:
    com.adobe.cq.forms.core.components.models.form 0.0.1

    • Field Detail

      • PN_RUNTIME_DOCUMENT_PATH

        static final java.lang.String PN_RUNTIME_DOCUMENT_PATH
        Name of the resource property that defines the document path containing the json
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1
        See Also:
        Constant Field Values

    • Method Detail

      • getMetaData

        FormMetaData getMetaData()
        Returns form metadata FormMetaData
        Returns:
        form meta data
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getId

        @Nullable
default @Nullable java.lang.String getId()
        Returns a unique identifier
        Returns:
        unique identifier
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getTitle

        default java.lang.String getTitle()
        Returns the form title
        Returns:
        form title
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getDescription

        default java.lang.String getDescription()
        Returns the form description
        Returns:
        form description
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getModel

        default java.util.Map<java.lang.String,​java.lang.Object> getModel()
        Returns the form model
        Returns:
        the form model, based on the document path configured or the items
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getDocumentPath

        default java.lang.String getDocumentPath()
        Returns the document path (dam asset) containing the form model json
        Returns:
        the document path containing form model json, if one was set, or null
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getEncodedCurrentPagePath

        @Nullable
@Nullable java.lang.String getEncodedCurrentPagePath()
        Returns base64 encoded current page path
        Returns:
        base64 encoded current page path
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getThankYouMessage

        java.lang.String getThankYouMessage()
        Returns the form thank you message
        Returns:
        form thank you message
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getThankYouPage

        java.lang.String getThankYouPage()
        Returns the form thank you page
        Returns:
        form thank you page
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getFormData

        default java.lang.String getFormData()
        Returns the form data
        Returns:
        the form data
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1