com.adobe.aemforms.fm.model

Class FormOptions

java.lang.Object

com.adobe.aemforms.fm.model.FormOptions

Direct Known Subclasses:

AFFOptions, AFOptions

public class FormOptions
extends Object

FormOptions represents the common configurable properties that will be honored while creating a Form through FormGenerationService.

Constructor Summary

Constructors

Constructor and Description
FormOptions()

Method Summary

Modifier and Type	Method and Description
String	getAnalyticsEnabled() Returns if analytics is enabled for the form.
String	getDescription() Returns the description of the form.
String	getFormLocation() Returns the Repository path of the directory that contains this form.
String	getName() Returns the name of the form.
NameConflictAction	getNameConflictAction() Returns the action to be taken in case of form name conflict.
String[]	getTags() Returns the cq:Tags associated with the form.
String	getTitle() Returns the Title of the form.
void	setAnalyticsEnabled(String analyticsEnabled) Sets if the analytics should be enabled on the form or not.
void	setDescription(String description) Set the description of the form.
void	setFormLocation(String formLocation) Set the repository path of the directory where form will be created.
void	setName(String name) Set the name of the form.
void	setNameConflictAction(NameConflictAction nameConflictAction) Set the action to be taken in case of form name conflict.
void	setTags(String[] tags) Set the cq:Tags associated with form.
void	setTitle(String title) Set the title of the form.

Constructor Detail

FormOptions

public FormOptions()

Method Detail

getFormLocation

public String getFormLocation()

Returns the Repository path of the directory that contains this form.

Returns:

String representing repository path of a directory that will contain the form.

setFormLocation

public void setFormLocation(String formLocation)

Set the repository path of the directory where form will be created. If this value is not set or is invalid, the form will be created in the directory where the Form Template reference resides.

Parameters:

formLocation - String representing a valid repository path of a directory that will contain the form.

getTitle

public String getTitle()

Returns the Title of the form.

Returns:

String representing the Title of the form.

setTitle

public void setTitle(String title)

Set the title of the form. If not set or valid, name will be set as title.

Parameters:

title - String representing the title of the form.

getName

public String getName()

Returns the name of the form.

Returns:

String representing the name of the form.

setName

public void setName(String name)

Set the name of the form. If characters other than alphabets, numbers, hyphens and underscores are specified, will be replaced by hyphens.If not set, will be generated based on the Form Template name.

Parameters:

name - String representing the name of the form.

getDescription

public String getDescription()

Returns the description of the form.

Returns:

String representing the description of the form.

setDescription

public void setDescription(String description)

Set the description of the form.

Parameters:

description - String representing the description of the form.

getTags

public String[] getTags()

Returns the cq:Tags associated with the form.

Returns:

String array of cq:Tags associated with the form.

setTags

public void setTags(String[] tags)

Set the cq:Tags associated with form.

Parameters:

tags - String array of cq:Tags to be associated with the form.

getNameConflictAction

public NameConflictAction getNameConflictAction()

Returns the action to be taken in case of form name conflict.

Returns:

Enum representing an action

setNameConflictAction

public void setNameConflictAction(NameConflictAction nameConflictAction)

Set the action to be taken in case of form name conflict. If not specified, fails the creation of the form in case of conflict.

Parameters:

nameConflictAction - Enum representing an action.

getAnalyticsEnabled

public String getAnalyticsEnabled()

Returns if analytics is enabled for the form.

Returns:

enabled if analytics is enabled for the form.

setAnalyticsEnabled

public void setAnalyticsEnabled(String analyticsEnabled)

Sets if the analytics should be enabled on the form or not.

Parameters:

analyticsEnabled - True if analytics needs to be enabled for the form.