com.adobe.aemforms.fm.model

Class FormsetItem

java.lang.Object

com.adobe.aemforms.fm.model.FormsetItem

public class FormsetItem
extends Object

FormsetItem contains the information about a Form in the Form Set. A List of FormsetItem is stored in FormsetOptions while passing to FormGenerationService to create Form Set.

Constructor Summary

Constructors

Constructor and Description
FormsetItem()

Method Summary

Modifier and Type	Method and Description
String	getDataRoot() return dataRoot of the Form.
String	getEligibiltyExpression() returns eligibility expression of the Form.
String	getFormIdentifier() returns identifier of the Form.
String	getFormPath() returns the full repository path(with name) where this Form exists.
void	setDataRoot(String dataRoot) sets dataRoot of the Form.
void	setEligibiltyExpression(String eligibiltyExpression) sets eligibility expression of the Form.
void	setFormIdentifier(String formIdentifier) sets the identifier of the Form.
void	setFormPath(String formPath) sets the full repository path(with name) of the Form.

Constructor Detail

FormsetItem

public FormsetItem()

Method Detail

getFormPath

public String getFormPath()

returns the full repository path(with name) where this Form exists.

Returns:

String representing formPath(with name)

setFormPath

public void setFormPath(String formPath)

sets the full repository path(with name) of the Form. This is mandatory field to specify. If null or empty, Form Set creation FAILS.

Parameters:

formPath - representing full repository path(with name) where this Form exists.

getFormIdentifier

public String getFormIdentifier()

returns identifier of the Form.

Returns:

String representing Form identifier.

setFormIdentifier

public void setFormIdentifier(String formIdentifier)

sets the identifier of the Form. This property is used to uniquely identify the Form in an eligibility expression. If null or empty, this is auto generated using the name of the Form. If 2 Forms have same name in the Form Set, auto-generation FAILS and thus, Form Set creation FAILS. If Form identifier of 2 Forms is same in the Form Set, Form Set creation FAILS.

Parameters:

formIdentifier -

getDataRoot

public String getDataRoot()

return dataRoot of the Form.

Returns:

String representing dataRoot.

setDataRoot

public void setDataRoot(String dataRoot)

sets dataRoot of the Form. Default is set to "/".

Parameters:

dataRoot -

getEligibiltyExpression

public String getEligibiltyExpression()

returns eligibility expression of the Form.

Returns:

String representing eligibility expression of the Form.

setEligibiltyExpression

public void setEligibiltyExpression(String eligibiltyExpression)

sets eligibility expression of the Form. Eligibility expressions in a Form Set are used to define and dynamically control Forms that are displayed to a user. An eligibility expression can be any valid JavaScript statement that returns a Boolean value. If the value of the expression is true, the Form is eligible to be displayed to the user. Eligibility expression for the first Form in Form Set is not executed. The first form is always displayed regardless of its eligibility expression.

Parameters:

eligibiltyExpression -