GuideContainer (AEM Forms API)

java.lang.Object
- com.adobe.cq.sightly.WCMUsePojo
- - com.adobe.aemds.guide.common.GuideNode
  - - com.adobe.aemds.guide.common.GuideContainer

All Implemented Interfaces:

FDField, StyledFDField, Serializable, org.apache.sling.scripting.sightly.pojo.Use
```
public class GuideContainer
extends GuideNode
```
GuideContainer encapsulates basic properties of an adaptive form Container. adaptive form Container contains the entire adaptive forms related semantics. This consists of few basic properties:
- XDP Reference of adaptive form if any
- Initialization State of adaptive form container
- Client Library if configured for the adaptive form
Since:

6.0

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.adobe.aemds.guide.common.GuideNode
  baseName, clientLibRef, error, i18n, id, inlineStyles, locale, localeName, logger, resource, resourceProps, slingRequest, xssapi

Constructor Summary

Constructors
Constructor and Description
`GuideContainer()`
`GuideContainer(org.apache.sling.api.resource.Resource resource)`
`GuideContainer(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.resource.Resource resource)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static GuideContainer`	`from(org.apache.sling.api.resource.Resource resource)` Static method to construct a `GuideContainer` model from a resource
`static GuideContainer`	`from(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.resource.Resource resource)` Static method to construct a `GuideContainer` model from a `Resource` and `SlingHttpServletRequest`
`String`	`getAfPath()` Returns the adaptive form Path configured.
`String`	`getAutoSaveStrategyFilePath()` Returns the entire path till init.jsp for the autoSave strategy selected in case of forms built over 6.0 For 6.1, it returns relative path to support overlay of auto save strategies
`String`	`getClientLibRef()` Returns the name of the client lib associated with the adaptive form.
`String`	`getCssFileRef()` Returns the path to the CSS file in CRXDE configured in the authoring of adaptive form
`org.apache.sling.commons.json.JSONObject`	`getCustomContextPropJson(javax.servlet.http.HttpServletRequest request)` Populates and returns the JSON Object from Custom Property Map attribute from request
`String`	`getDorTemplateRef()` Returns the path of the XDP Template used for generating Document of Record.
`String`	`getDoRType()` Returns the document of record type configured for the adaptive form
`String`	`getGuideContext(GuideModelTransformer guideModelTransformer)` Returns adaptive form specific data required to render an adaptive form
`String`	`getGuideInitializationState(boolean clientSideMerge)`
`String`	`getGuideJson()` Returns the adaptive form information for rendering an adaptive form on Client
`String`	`getLetterRef()`
`String`	`getMetaTemplateRef()` Returns meta-template reference associated with adaptive form if exists otherwise empty string.
`String`	`getMobileLayout()`
`String`	`getPagePath()` Returns the path of the page in which the guideContainer is present.
`String`	`getPrefillService()` Returns the prefill service configured in the form
`String`	`getRedirect()`
`GuidePanel`	`getRootPanel()` Returns the root panel associated with the adaptive form.
`GuideSchemaType`	`getSchema()` Returns the `GuideSchemaType` configured in the adaptive form
`String`	`getSchemaRef()` Returns the path of the Schema used in the adaptive form
`String`	`getSchemaType()` Deprecated.
`GuideItemsContainer`	`getToolbar()` Returns the tool bar of the adaptive form container
`String`	`getXDPName()` Returns the name of the XDP used in adaptive form.
`String`	`getXdpRef()` Deprecated.
`String`	`getXfaJson()` Returns the XDP Template information required to render XDP based adaptive forms
`String`	`getXfaRenderContext()` Returns the parameters required for XFA based adaptive forms to render.
`String`	`getXsdRef()` Deprecated.
`boolean`	`isAdobeSignEnabled()` Returns whether AdobeSign is enabled or not
`boolean`	`isDoRSubmissionEnabled()` Returns whether send email action should attach DoR PDF or not
`boolean`	`isFormFillerFirstSigner()` Returns whether Form filler is first signer or not
`boolean`	`isGuideSyncRequired()` Returns if the sync of adaptive form is required or not due to any changes done in XDP
`boolean`	`isMetaTemplateUpdated()` Returns true if meta-template associated with adaptive form is updated.
`boolean`	`isMetaTemplateValid()` Checks if path pointed by metaTemplateRef is valid resource.
`boolean`	`isRenderCall()` Gets the value for render
`boolean`	`isSignatureConfiguredCorrectly()` Returns whether signers are configured correctly or not.
`boolean`	`validate(org.apache.sling.api.resource.ResourceResolver serviceResourceResolver)` Validate guide container if all required nodes are present, if not present then create them

Methods inherited from class com.adobe.aemds.guide.common.GuideNode
activate, externalize, externalize, getAddMessage, getAppearance, getAuthoringConfigJSON, getBindRef, getColspan, getCssClassName, getDescription, getEnabled, getEnabledExp, getError, getFieldInlineStyles, getGuideFieldType, getHeight, getId, getInlineCssClass, getInlineStyles, getIsEditMode, getIsRepeatable, getIsTitleRichText, getItems, getLayoutPath, getLayoutProperty, getLongDescriptionInlineStyles, getName, getNavTitle, getNodeClass, getPath, getQuestionMarkInlineStyles, getRemoveMessage, getResourceSuperType, getResourceType, getResponsiveClasses, getResponsiveConfiguration, getSlingRequest, getStyles, getTargetVersion, getTitle, getToolbarPosition, getVersion, getVisible, getVisibleExp, getWidth, getXssapi, getXssDescription, isDocumentFragmentGroup, isLayoutNavigable, isMenuRequired, isValid, isValidDorTemplateRef, setClientLibRef, setResource, setSlingRequest, syncNode

- Constructor Detail
  - GuideContainer
```
public GuideContainer()
```
  - GuideContainer
```
public GuideContainer(org.apache.sling.api.SlingHttpServletRequest request,
                      org.apache.sling.api.resource.Resource resource)
```
  - GuideContainer
```
public GuideContainer(org.apache.sling.api.resource.Resource resource)
```
- Method Detail
  - getRedirect
```
public String getRedirect()
```
  - validate
```
public boolean validate(org.apache.sling.api.resource.ResourceResolver serviceResourceResolver)
```
    Validate guide container if all required nodes are present, if not present then create them
    
    Overrides:
    
    validate in class GuideNode
    
    Parameters:
    
    serviceResourceResolver - reference to service resource resolver since validate would require access to immutable content
    
    Returns:
  - getDoRType
```
public String getDoRType()
```
    Returns the document of record type configured for the adaptive form
    
    Returns:
    
    String representing Document of record type
  - getXdpRef
```
public String getXdpRef()
```
    Deprecated.
    
    Returns the path of the XDP used in the adaptive form
    
    Returns:
    
    String representing the XDP reference
  - getLetterRef
```
public String getLetterRef()
```
  - getMetaTemplateRef
```
public String getMetaTemplateRef()
```
    Returns meta-template reference associated with adaptive form if exists otherwise empty string.
    
    Returns:
    
    path of meta-template if exists otherwise empty string
  - getAutoSaveStrategyFilePath
```
public String getAutoSaveStrategyFilePath()
```
    Returns the entire path till init.jsp for the autoSave strategy selected in case of forms built over 6.0 For 6.1, it returns relative path to support overlay of auto save strategies
  - getDorTemplateRef
```
public String getDorTemplateRef()
```
    Returns the path of the XDP Template used for generating Document of Record. This returns empty String in case of XDP based adaptive forms or if no DOR template is associated while creating adaptive forms
    
    Returns:
    
    Path of the DOR Template in CRXDE
  - getXsdRef
```
public String getXsdRef()
```
    Deprecated.
    
    Returns the path of the XSD used in the adaptive form
    
    Returns:
    
    reference to the XSD configured for the adaptive form
  - getSchemaRef
```
public String getSchemaRef()
```
    Returns the path of the Schema used in the adaptive form
    
    Returns:
    
    reference to the Schema configured for the adaptive form. This reference could be XSD, XDP, JSON or an FDM
  - getSchemaType
```
public String getSchemaType()
```
    Deprecated.
    
    Returns the type of the schema configured in the adaptive form
    
    Returns:
    
    String representing schemaType of form it could have any of the following values present in the GuideSchemaType enum
  - getPrefillService
```
public String getPrefillService()
```
    Returns the prefill service configured in the form
    
    Returns:
  - getSchema
```
public GuideSchemaType getSchema()
```
    Returns the GuideSchemaType configured in the adaptive form
    
    Returns:
    
    GuideSchemaType
  - getCssFileRef
```
public String getCssFileRef()
```
    Returns the path to the CSS file in CRXDE configured in the authoring of adaptive form
    
    Returns:
    
    String representing the path to the CSS file configured during authoring.
  - getClientLibRef
```
public String getClientLibRef()
```
    Returns the name of the client lib associated with the adaptive form.
    
    Overrides:
    
    getClientLibRef in class GuideNode
    
    Returns:
    
    String Name of the client lib
  - getAfPath
```
public String getAfPath()
```
    Returns the adaptive form Path configured. Used particularly for usecase when someone wants to embed adaptive forms inside a web page
    
    Returns:
    
    path of the adaptive form configured
  - getToolbar
```
public GuideItemsContainer getToolbar()
```
    Returns the tool bar of the adaptive form container
    
    Returns:
    
    GuideItemsContainer toolbar of the adaptive form container
    
    See Also:
    
    GuideItemsContainer
  - getRootPanel
```
public GuidePanel getRootPanel()
```
    Returns the root panel associated with the adaptive form. Root Panel is the parent panel which holds other panel's
    
    Returns:
    
    Reference to the root panel GuidePanel
    
    See Also:
    
    GuidePanel
  - isGuideSyncRequired
```
public boolean isGuideSyncRequired()
```
    Returns if the sync of adaptive form is required or not due to any changes done in XDP
    
    Returns:
    
    boolean indicating if sync required or not
  - isAdobeSignEnabled
```
public boolean isAdobeSignEnabled()
```
    Returns whether AdobeSign is enabled or not
    
    Returns:
  - isDoRSubmissionEnabled
```
public boolean isDoRSubmissionEnabled()
```
    Returns whether send email action should attach DoR PDF or not
    
    Returns:
  - isFormFillerFirstSigner
```
public boolean isFormFillerFirstSigner()
```
    Returns whether Form filler is first signer or not
    
    Returns:
  - isSignatureConfiguredCorrectly
```
public boolean isSignatureConfiguredCorrectly()
```
    Returns whether signers are configured correctly or not.
    
    Returns:
  - isMetaTemplateUpdated
```
public boolean isMetaTemplateUpdated()
```
    Returns true if meta-template associated with adaptive form is updated.
    
    Returns:
    
    boolean indicating if meta-template has been updated.
  - getMobileLayout
```
public String getMobileLayout()
```
  - getXDPName
```
public String getXDPName()
```
    Returns the name of the XDP used in adaptive form. Returns null for non XDP based Forms
    
    Returns:
    
    String representing the name of the XDP used
  - getXfaRenderContext
```
public String getXfaRenderContext()
                           throws GuideException
```
    Returns the parameters required for XFA based adaptive forms to render.
    
    Returns:
    
    containing these parameters
    
    Throws:
    
    GuideException
  - getXfaJson
```
public String getXfaJson()
                  throws GuideException
```
    Returns the XDP Template information required to render XDP based adaptive forms
    
    Returns:
    
    String containing the XDP Template Information
    
    Throws:
    
    GuideException
  - getGuideContext
```
public String getGuideContext(GuideModelTransformer guideModelTransformer)
```
    Returns adaptive form specific data required to render an adaptive form
    
    Returns:
    
    String containing the specific data
  - getGuideJson
```
public String getGuideJson()
```
    Returns the adaptive form information for rendering an adaptive form on Client
    
    Returns:
    
    String containing adaptive form Information
  - getGuideInitializationState
```
public String getGuideInitializationState(boolean clientSideMerge)
```
  - isRenderCall
```
public boolean isRenderCall()
```
    Gets the value for render
    
    Returns:
    
    boolean value indicating if its a render call
  - getCustomContextPropJson
```
public org.apache.sling.commons.json.JSONObject getCustomContextPropJson(javax.servlet.http.HttpServletRequest request)
```
    Populates and returns the JSON Object from Custom Property Map attribute from request
    
    Parameters:
    
    request -
    
    Returns:
    
    json object representing the custom context property set in the request
  - getPagePath
```
public String getPagePath()
```
    Returns the path of the page in which the guideContainer is present.
    
    Returns:
    
    path of the page in which the adaptive form container is present
  - isMetaTemplateValid
```
public boolean isMetaTemplateValid()
```
    Checks if path pointed by metaTemplateRef is valid resource.
    
    Returns:
    
    false if the resource is null or metaTemplateRef property is null/empty string, true otherwise
  - from
```
public static GuideContainer from(org.apache.sling.api.resource.Resource resource)
```
    Static method to construct a GuideContainer model from a resource
    
    Parameters:
    
    resource - guideContainer Resource
    
    Returns:
    
    GuideContainer bean
  - from
```
public static GuideContainer from(org.apache.sling.api.SlingHttpServletRequest request,
                                  org.apache.sling.api.resource.Resource resource)
```
    Static method to construct a GuideContainer model from a Resource and SlingHttpServletRequest
    
    Parameters:
    
    resource - guideContainer Resource
    
    request - SlingHttpServletRequest
    
    Returns:
    
    GuideContainer bean

Class GuideContainer

Field Summary

Fields inherited from class com.adobe.aemds.guide.common.GuideNode

Constructor Summary

Method Summary

Methods inherited from class com.adobe.aemds.guide.common.GuideNode

Constructor Detail

GuideContainer

GuideContainer

GuideContainer

Method Detail

getRedirect

validate

getDoRType

getXdpRef

getLetterRef

getMetaTemplateRef

getAutoSaveStrategyFilePath

getDorTemplateRef

getXsdRef

getSchemaRef

getSchemaType

getPrefillService

getSchema

getCssFileRef

getClientLibRef

getAfPath

getToolbar

getRootPanel

isGuideSyncRequired

isAdobeSignEnabled

isDoRSubmissionEnabled

isFormFillerFirstSigner

isSignatureConfiguredCorrectly

isMetaTemplateUpdated

getMobileLayout

getXDPName

getXfaRenderContext

getXfaJson

getGuideContext

getGuideJson

getGuideInitializationState

isRenderCall

getCustomContextPropJson

getPagePath

isMetaTemplateValid

from

from