com.adobe.aemforms.fm.model

Class AFOptions

java.lang.Object

com.adobe.aemforms.fm.model.FormOptions

com.adobe.aemforms.fm.model.AFOptions

public class AFOptions
extends FormOptions

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

Constructor Summary

Constructors

Constructor and Description
AFOptions()

Method Summary

Modifier and Type	Method and Description
String	getAfTemplatePath() Returns the Repository path of the Adaptive Form template used for creating the form
String	getFormModelRef() Returns the repository path of the file which will be used to model Adaptive Form
String	getFormModelRoot() Returns the Repository path of the form model root element.
FormModel	getFormModelType() Returns the form model type used for creating adaptive form.
String	getXdpRef() Deprecated. Use getFormModelRef instead. Returns the Repository path of the Form Template.
void	setAfTemplatePath(String afTemplatePath) Set the Repository path of the Adaptive Form template used for creating the form.
void	setFormModelRef(String formModelRef) Sets the repository path of the Form Model file which to be used for creating Adaptive Form
void	setFormModelRoot(String formModelRoot) Sets the form model root element to be picked for modeling the Adaptive Form.
void	setFormModelType(FormModel formModel) Sets the type of form model to use for creating adaptive form.
void	setXdpRef(String xdpRef) Deprecated. User setFormModelRef instead. Set the Repository path of the Form Template to model the Adaptive Form.

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

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

Constructor Detail

AFOptions

public AFOptions()

Method Detail

getAfTemplatePath

public String getAfTemplatePath()

Returns the Repository path of the Adaptive Form template used for creating the form

Returns:

String representing the Repository path of the Adaptive Form template.

setAfTemplatePath

public void setAfTemplatePath(String afTemplatePath)

Set the Repository path of the Adaptive Form template used for creating the form. It is mandatory to set afTemplatePath for Adaptive Form creation.

Parameters:

afTemplatePath - String representing a valid Repository path of the Adaptive Form template.

getXdpRef

@Deprecated
public String getXdpRef()

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

Returns:

String representing a Repository path of the Form Template.

setXdpRef

@Deprecated
public void setXdpRef(String xdpRef)

Deprecated. User setFormModelRef instead. Set the Repository path of the Form Template to model the Adaptive Form.

Parameters:

xdpRef - String representing a valid Repository path of 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.

Parameters:

formModelRoot - String representing valid form model root.

getFormModelRef

public String getFormModelRef()

Returns the repository path of the file which will be used to model Adaptive Form

Returns:

formModelRef

setFormModelRef

public void setFormModelRef(String formModelRef)

Sets the repository path of the Form Model file which to be used for creating Adaptive Form

getFormModelType

public FormModel getFormModelType()

Returns the form model type used for creating adaptive form.

Returns:

FormModel specifying type of model being used for creating adaptive form.

setFormModelType

public void setFormModelType(FormModel formModel)

Sets the type of form model to use for creating adaptive form.

Parameters:

formModel - FormModel specifying type of model to be used for creating adaptive form.