com.adobe.aemforms.fm.model

Class AFFOptions

java.lang.Object

com.adobe.aemforms.fm.model.FormOptions

com.adobe.aemforms.fm.model.AFFOptions

public class AFFOptions
extends FormOptions

AFFOptions represents the Adaptive Form Fragment Configurable properties that will be honored while creating Adaptive Form Fragment through FormGenerationService.

Constructor Summary

Constructors

Constructor and Description
AFFOptions()

Method Summary

Modifier and Type	Method and Description
String	getFormModelRef() Returns the repository path of the form model schema file which will be used to model Adaptive Form Fragment.
String	getFormModelRoot() Returns the Repository path of the form model root element.
FormModel	getFormModelType() Returns the form model type to be used for creating Adaptive Form Fragment.
String	getFragmentSubform() Deprecated. Use getFormModelRoot instead. Returns the som-expression of a subform in the Form Template from which Adaptive Form Fragment is generated.
String	getXdpRef() Deprecated. Use getFormModelRef instead. Returns the Repository path of the Form Template.
void	setFormModelRef(String formModelRef) Sets the repository path of the form model schema file which to be used for creating Adaptive Form Fragment.
void	setFormModelRoot(String formModelRoot) Sets the form model root element to be picked for modeling the Adaptive Form Fragment.
void	setFormModelType(FormModel formModel) Sets the type of form model to use for creating Adaptive Form Fragment.
void	setFragmentSubform(String fragmentSubform) Deprecated. Use setFormModelRoot instead. Set the som-expression of a subform that is to be used to generate the Adaptive Form Fragment. This subform should be marked as a fragment in the Form Template. If this value is not found or is invalid, the adaptive form fragment is created using the first subform marked as fragment in the Form Template.
void	setXdpRef(String xdpRef) Deprecated. Use setFormModelRef instead. Set the Repository path of the Form Template to model the Adaptive Form Fragment. It is mandatory to set xdpRef for Adaptive Form Fragment creation.

Methods inherited from class com.adobe.aemforms.fm.model.FormOptions

getDescription, getFormLocation, getName, getNameConflictAction, getTags, getTitle, setDescription, setFormLocation, setName, setNameConflictAction, setTags, setTitle

Constructor Detail

AFFOptions

public AFFOptions()

Method Detail

getXdpRef

@Deprecated
public String getXdpRef()

Deprecated. Use getFormModelRef instead. Returns the Repository path of the Form Template.

Returns:

String representing the Repository path of the Form Template.

setXdpRef

@Deprecated
public void setXdpRef(String xdpRef)

Deprecated. Use setFormModelRef instead. Set the Repository path of the Form Template to model the Adaptive Form Fragment. It is mandatory to set xdpRef for Adaptive Form Fragment creation.

Parameters:

xdpRef - String representing a valid Repository path of the Form Template.

getFragmentSubform

@Deprecated
public String getFragmentSubform()

Deprecated. Use getFormModelRoot instead. Returns the som-expression of a subform in the Form Template from which Adaptive Form Fragment is generated.

Returns:

String representing a som-expression.

setFragmentSubform

@Deprecated
public void setFragmentSubform(String fragmentSubform)

Deprecated. Use setFormModelRoot instead. Set the som-expression of a subform that is to be used to generate the Adaptive Form Fragment. This subform should be marked as a fragment in the Form Template. If this value is not found or is invalid, the adaptive form fragment is created using the first subform marked as fragment in the Form Template.

Parameters:

fragmentSubform - String representing a som-expression of a subform in the Form Template.

getFormModelRoot

public String getFormModelRoot()

Returns the Repository path of the form model root element.

Returns:

String representing the form model root element.

setFormModelRoot

public void setFormModelRoot(String formModelRoot)

Sets the form model root element to be picked for modeling the Adaptive Form Fragment. If not specified, fragment generation will fail.

Parameters:

formModelRoot - String representing valid form model root.

getFormModelRef

public String getFormModelRef()

Returns the repository path of the form model schema file which will be used to model Adaptive Form Fragment.

Returns:

formModelRef Path.

setFormModelRef

public void setFormModelRef(String formModelRef)

Sets the repository path of the form model schema file which to be used for creating Adaptive Form Fragment.

getFormModelType

public FormModel getFormModelType()

Returns the form model type to be used for creating Adaptive Form Fragment. Defaults to FORM_TEMPLATE

Returns:

FormModel to be used for creating Adaptive Form Fragment.

setFormModelType

public void setFormModelType(FormModel formModel)

Sets the type of form model to use for creating Adaptive Form Fragment.

Parameters:

formModel - FormModel to be used for creating Adaptive Form Fragment.