com.adobe.aemforms.fm.model

Class FormsetOptions

java.lang.Object

com.adobe.aemforms.fm.model.FormsetOptions

public class FormsetOptions
extends Object

FormsetOptions represents the Form Set Configurable properties that will be honored while creating Form Set through FormGenerationService.

Constructor Summary

Constructors

Constructor and Description
FormsetOptions() Constructor to set default values.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description of the Form Set.
List<FormsetItem>	getFormsetItemList() List of FormssetItem in this Form Set.
String	getFormsetLocation() Returns the Repository path of the directory that contains this Form Set.
String	getName() Returns the name of the Form Set.
NameConflictAction	getNameConflictAction() Returns the action to be taken in case of Form Set name conflict.
String	getRenderProfile() returns render profile associated with this Form Set.
String	getSubmitURL() returns the submit URL.
String[]	getTags() Returns the cq:Tags associated with the Form Set.
String	getTitle() Returns the Title of the Form Set.
void	setDescription(String description) Set the description of the Form Set.
void	setFormsetItemList(List<FormsetItem> formsetItemList) sets the List of FormsetOtem in this Form Set.
void	setFormsetLocation(String location) Set the repository path of the directory where Form Set will be created.
void	setName(String name) Sets the name of the Form Set.
void	setNameConflictAction(NameConflictAction nameConflictAction) Set the action to be taken in case of Form Set name conflict.
void	setRenderProfile(String renderProfile) sets profile REST endpoint that contains associated Profile Renderer.
void	setSubmitURL(String submitURL) sets the submit URL.
void	setTags(String[] tags) Set the cq:Tags associated with Form Set.
void	setTitle(String title) Set the title of the Form Set.

Constructor Detail

FormsetOptions

public FormsetOptions()

Constructor to set default values.

Method Detail

getRenderProfile

public String getRenderProfile()

returns render profile associated with this Form Set.

Returns:

String representing renderProfile

setRenderProfile

public void setRenderProfile(String renderProfile)

sets profile REST endpoint that contains associated Profile Renderer. Profile Renderer are JSP pages responsible for generating HTML representation of the Form Set by calling the Forms OSGi service. Default profile is set to "/content/forms/formsets/profiles/default"

Parameters:

renderProfile - String representing render profile.

getSubmitURL

public String getSubmitURL()

returns the submit URL.

Returns:

String reporeseting submit URL.

setSubmitURL

public void setSubmitURL(String submitURL)

sets the submit URL. This property specifies the url to which the form data xml is posted.

Parameters:

submitURL - String representing submit URL.

getFormsetItemList

public List<FormsetItem> getFormsetItemList()

List of FormssetItem in this Form Set. FormsetItem contains the details of a Form in this Form Set.

Returns:

List of the FormsetItem in this Form Set.

setFormsetItemList

public void setFormsetItemList(List<FormsetItem> formsetItemList)

sets the List of FormsetOtem in this Form Set. FormsetItem contains the details of a Form in this Form Set. This is mandatory field to specify. If null or empty, Form Set creation will FAIL.

Parameters:

formsetItemList - representing List Forms in this Form Set.

getFormsetLocation

public String getFormsetLocation()

Returns the Repository path of the directory that contains this Form Set.

Returns:

String representing repository path of a directory that will contain this Form Set.

setFormsetLocation

public void setFormsetLocation(String location)

Set the repository path of the directory where Form Set will be created. This is mandatory field to specify. If null or empty, Form Set creation will FAIL.

Parameters:

location - String representing a valid repository path of a directory that will contain the Form Set.

getTitle

public String getTitle()

Returns the Title of the Form Set.

Returns:

String representing the Title of the Form Set.

setTitle

public void setTitle(String title)

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

Parameters:

title - String representing the title of the Form Set.

getName

public String getName()

Returns the name of the Form Set.

Returns:

String representing the name of the Form Set.

setName

public void setName(String name)

Sets the name of the Form Set. If characters other than alphabets, numbers, hyphens and underscores are specified, will be replaced by hyphens. This is mandatory field to specify. If null or empty, Form Set creation will FAIL.

Parameters:

name - String representing the name of the Form Set.

getDescription

public String getDescription()

Returns the description of the Form Set.

Returns:

String representing the description of the Form Set.

setDescription

public void setDescription(String description)

Set the description of the Form Set.

Parameters:

description - String representing the description of the Form Set.

getTags

public String[] getTags()

Returns the cq:Tags associated with the Form Set.

Returns:

String array of cq:Tags associated with the Form Set.

setTags

public void setTags(String[] tags)

Set the cq:Tags associated with Form Set.

Parameters:

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

getNameConflictAction

public NameConflictAction getNameConflictAction()

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

Returns:

Enum representing an action

setNameConflictAction

public void setNameConflictAction(NameConflictAction nameConflictAction)

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

Parameters:

nameConflictAction - Enum representing an action.