Package org.ametys.plugins.forms.repository

Class Form

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<FormFactory>

org.ametys.plugins.repository.jcr.SimpleModelAwareAmetysObject<FormFactory>

org.ametys.cms.repository.SimpleIndexableAmetysObject<FormFactory>

org.ametys.cms.repository.DefaultIndexableTraversableAmetysObject<FormFactory>

org.ametys.plugins.forms.repository.Form

All Implemented Interfaces:

IndexableAmetysObject, ModifiableIndexableAmetysObject, IndexableDataHolder, ModifiableIndexableDataHolder, IndexableJCRAmetysObject, ACLAmetysObject, AmetysObject, CopiableAmetysObject, ModelAwareAmetysObject, ModifiableModelAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, JCRAmetysObject, JCRTraversableAmetysObject, ModelAwareJCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, MovableAmetysObject, RemovableAmetysObject, TraversableAmetysObject, SiteAwareAmetysObject

public class Form
extends DefaultIndexableTraversableAmetysObject<FormFactory>
implements MovableAmetysObject, SiteAwareAmetysObject, CopiableAmetysObject

Class representing a form, backed by a JCR node.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Form.ExpirationPolicy	Policy for expired entries
static enum	Form.FormProfile	Rights profiles

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMIN_EMAIL_BODY	Property name for form entries admin email body
static final String	ADMIN_EMAIL_LANGUAGE	Property name for form entries admin email language
static final String	ADMIN_EMAIL_SUBJECT	Property name for form entries admin email subject
static final String	ADMIN_EMAILS	Property name for form entries admin emails
static final String	ADMIN_EMAILS_OTHER	Property name for form entries admin emails alternative source
static final String	AUTHOR	Property name for form author
static final String	CLOSED_MSG	Property name for form displayed message when closed because of limited number of entries
static final String	CONTRIBUTOR	Property name for form last contributor
static final String	CREATIONDATE	Property name for form creation date
static final String	DESCRIPTION	Property name for form description
static final String	END_DATE	Property name for form end date
static final String	EXPIRATION_ENABLED	Property name for form to activate entry expiration
static final String	EXPIRATION_PERIOD	Property name for form entries expiration period
static final String	EXPIRATION_POLICY	Property name for form to define the action taken after the form entry expiration
static final String	LASTMODIFICATIONDATE	Property name for form last modification date
static final String	LIMIT_ENTRIES_ENABLED	Property name for form to limit the entries
static final String	LIMIT_TO_ONE_ENTRY_BY_USER	Property name for form to limit one entry by user
static final String	MAX_ENTRIES	Property name for form's authorized max number of entries
static final String	QUEUE_BODY	Property name for form acknowledgement of queue's body
static final String	QUEUE_CLOSED_MSG	Property name for form displayed message when closed because of limited number of entries and a queue is enabled
static final String	QUEUE_ENABLED	Property name for form to enable queue
static final String	QUEUE_RECEIVER	Property name for form acknowledgement of queue's receiver
static final String	QUEUE_SENDER	Property name for form acknowledgement of queue's sender
static final String	QUEUE_SIZE	Property name for form's queue size
static final String	QUEUE_SUBJECT	Property name for form acknowledgement of queue's subject
static final String	RECEIPT_BODY	Property name for form acknowledgement of receipt's body
static final String	RECEIPT_RECEIVER	Property name for form acknowledgement of receipt's receiver
static final String	RECEIPT_SENDER	Property name for form acknowledgement of receipt's sender
static final String	RECEIPT_SUBJECT	Property name for form acknowledgement of receipt's subject
static final String	REMAINING_MSG	Property name for form displayed message when entries are limited in number
static final String	SEARCH_COLUMNS	Property name for form search columns
static final String	SEARCH_CRITERIA	Property name for form search criteria (stored as JSON)
static final String	SEARCH_INITIAL_SORT_COLUMN	Property name for form search initial sort column
static final String	SEARCH_INITIAL_SORT_ORDER	Property name for form search initial sort order (ASC or DESC)
static final String	START_DATE	Property name for form start date
static final String	TITLE	Property name for form displayed name
static final String	WORKFLOWNAME	Property name for form workflow name

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Fields inherited from interface org.ametys.web.repository.SiteAwareAmetysObject

METADATA_SITE

Constructor Summary

Constructors

Constructor	Description
Form(javax.jcr.Node node, String parentPath, FormFactory factory)	Creates an Form.

Method Summary

Modifier and Type	Method	Description
boolean	canMoveTo(AmetysObject newParent)	Test if a move can be a success or if it is impossible (e.g.
Form	copyTo(ModifiableTraversableAmetysObject parent, String name)	Copy the current AmetysObject to the given object.
AmetysObject	copyTo(ModifiableTraversableAmetysObject parent, String name, List<String> restrictTo)	Copy the current AmetysObject to the given object if it is not in the restriction list.
void	deleteQuestionsRule(String sourceQuestionId)	Delete the rules having sourceQuestionId as sourceId
void	enableQueue(boolean enabled)	Enable of not the queue
String	findUniqueQuestionName(String originalName)	Returns a unique question name in the form
String	findUniqueQuestionTitle(String originalTitle)	Returns a unique question title in the form
List<FormEntry>	getActiveEntries()	Get the active form entries.
Optional<String>	getAdminEmailBody()	Get the admin email body
Optional<String>	getAdminEmailLanguage()	Get the admin email language
Optional<String[]>	getAdminEmails()	Get the admin emails
Optional<String>	getAdminEmailSubject()	Get the admin email subject
UserIdentity	getAuthor()	Get the author of the form
Optional<String>	getClosedMessage()	Get the message that will be displayed to users when the entries limit is reached
Optional<String>	getClosedQueueMessage()	Get the message that will be displayed to users when the entries limit is reached and a queue is enabled
UserIdentity	getContributor()	Get the last contributor of the form
ZonedDateTime	getCreationDate()	Get the date of the last modification of the form
String	getDescription()	Get the description of the form
LocalDate	getEndDate()	Get the end date
List<FormEntry>	getEntries()	Get the form entries.
long	getExpirationPeriod()	Get the expiration period in number of months
Form.ExpirationPolicy	getExpirationPolicy()	Get the expiration policy
ZonedDateTime	getLastModificationDate()	Get the date of the last modification of the form
Optional<Long>	getMaxEntries()	Get the max number limit for entries in this form
Optional<String>	getOtherAdminEmails()	Get the alternative source for admin emails
List<FormPage>	getPages()	Get the form pages.
FormQuestion	getQuestion(String name)	Get a question by its name.
List<FormQuestion>	getQuestions()	Get the form questions.
List<String>	getQuestionsNames()	Get all the nameForForms of the questions in this form
Map<FormQuestion,Rule>	getQuestionsRule(String sourceQuestionId)	Get the rules having sourceQuestionId as sourceId
Optional<String>	getQueueMailBody()	Get the email's body for notifying exit of queue.
Optional<String>	getQueueMailReceiver()	Get the email's receiver for notifying exit of queue.
Optional<String>	getQueueMailSender()	Get the email's sender for notifying exit of queue.
Optional<String>	getQueueMailSubject()	Get the email's subject for notifying exit of queue.
Optional<Long>	getQueueSize()	Get the queue max size in this form
Optional<String>	getReceiptBody()	Get the receipt's body of this form.
Optional<String>	getReceiptReceiver()	Get the receipt's receiver of this form.
Optional<String>	getReceiptSender()	Get the receipt's sender of this form.
Optional<String>	getReceiptSubject()	Get the receipt's subject of this form.
Optional<String>	getRemainingMessage()	Get the message that will be displayed to users when filling the form if a max entries limit is set
String[]	getSearchColumns()	Get the search columns
String	getSearchCriteria()	Get the search criteria JSON configuration
String	getSearchInitialSortColumn()	Get the search initial sort column name
String	getSearchInitialSortOrder()	Get the search initial sort order
Site	getSite()	Returns this object's site.
String	getSiteName()	Returns this object's site name.
LocalDate	getStartDate()	Get the start date
String	getTitle()	Get the title of the form
String	getWorkflowName()	Get the name of the workflow applied to the form
boolean	hasEntries()	true if the form has entries
boolean	hasWorkflow()	true if the form has a workflow
boolean	isCacheable()	Returns true if the form is cacheable.
boolean	isEntriesLimited()	Get if the form entries are limited
boolean	isExpirationEnabled()	Determines if form has an expiration policy for its entries
boolean	isLimitedToOneEntryByUser()	Get if this form is limited to one entry by user
boolean	isMiniSurvey()	Indicate is this form can be considered as a mini survey
boolean	isQuestionNameUnique(String uniqueName)	Verify that no question has the same name for form as the current question in this form
boolean	isQueueEnabled()	Get if a queue is enabled
void	limitEntries(boolean limitEntries)	Limit or not the entries of the form
void	limitToOneEntryByUser(boolean limit)	Limit or not to one entry by user
void	moveTo(AmetysObject newParent, boolean renameIfExist)	Move the current object as a new child of the given object.
void	orderBefore(AmetysObject siblingNode)	Order a node before another sibling node (or as the last node)
void	setAdminEmailBody(String body)	Set the admin email body
void	setAdminEmailLanguage(String language)	Set the admin email language
void	setAdminEmails(String[] emails)	Set the admin emails
void	setAdminEmailSubject(String subject)	Set the admin email subject
void	setAuthor(UserIdentity author)	Set the author of this form.
void	setClosedMessage(String msg)	Set the message that will be displayed to users when the entries limit is reached
void	setClosedQueueMessage(String msg)	Set the message that will be displayed to users when the entries limit is reached and a queue is enabled
void	setContributor(UserIdentity contributor)	Set the last contributor of this form.
void	setCreationDate(ZonedDateTime creationDate)	Set the date of the creation.
void	setDescription(String description)	Set the description of this form.
void	setEndDate(LocalDate date)	Set the end date
void	setExpirationPolicy(boolean enabled, long expirationPeriod, Form.ExpirationPolicy policy)	Set or remove an expiration policy for entries
void	setLastModificationDate(ZonedDateTime lastModificationDate)	Set the date of the last modification.
void	setMaxEntries(Long max)	Set the max number limit for entries in this form
void	setOtherAdminEmails(String emails)	Set the alternative source for admin emails
void	setQueueMailBody(String body)	Set the email's body for notifying exit of queue.
void	setQueueMailSender(String sender)	Set the email's sender for notifying exit of queue.
void	setQueueMailSubject(String subject)	Set the email's subject for notifying exit of queue.
void	setQueueMailtReceiver(String receiver)	Set the email's receiver for notifying exit of queue.
void	setQueueSize(Long max)	Set the queue max size in this form
void	setReceiptBody(String body)	Set the receipt's body of this form.
void	setReceiptReceiver(String receiver)	Set the receipt's receiver of this form.
void	setReceiptSender(String sender)	Set the receipt's sender of this form.
void	setReceiptSubject(String subject)	Set the receipt's subject of this form.
void	setRemainingMessage(String msg)	Set the message that will be displayed to users when filling the form if a max entries limit is set
void	setSearchColumns(String[] columns)	Set the search columns
void	setSearchCriteria(String criteriaJson)	Set the search criteria JSON configuration
void	setSearchInitialSortColumn(String column)	Set the search initial sort column name
void	setSearchInitialSortOrder(String order)	Set the search initial sort order
void	setStartDate(LocalDate date)	Set the start date
void	setTitle(String title)	Set the title of this form.
void	setWorkflowName(String workflowName)	Set the name of the workflow.

Methods inherited from class org.ametys.cms.repository.DefaultIndexableTraversableAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, createChild, disallowInheritance, getChild, getChildren, getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, hasChild, isInheritanceDisallowed, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

Methods inherited from class org.ametys.cms.repository.SimpleIndexableAmetysObject

getComposite, getComposite, getDataHolder, getExternalComposite, getExternalComposite, getExternalRepeater, getExternalRepeater, getLocalComposite, getLocalComposite, getLocalRepeater, getLocalRepeater, getParentDataHolder, getRepeater, getRepeater, getRootDataHolder, indexData

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleModelAwareAmetysObject

dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAX, dataToSAXForEdition, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModel, getModelItemTypeExtensionPoint, getRepositoryData, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, removeValue, setExternalValue, setLocalValue, setStatus, setValue, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

dataToJSON, dataToSAX, equals, getDataNames, getValue, getValueOrDefault, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getValue, getValueOrDefault, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.cms.data.ametysobject.IndexableAmetysObject

getSystemPropertyExtensionPoint, indexData

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelAwareAmetysObject

getModel

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModelItemTypeExtensionPoint, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableDataHolder

getRepositoryData, removeValue, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableModelAwareDataHolder

removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, setExternalValue, setLocalValue, setStatus, setValue, setValue, synchronizeValues, synchronizeValues, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChildAt, getChildPosition

Field Details

TITLE

public static final String TITLE

Property name for form displayed name

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Property name for form description

See Also:

• Constant Field Values

AUTHOR

public static final String AUTHOR

Property name for form author

See Also:

• Constant Field Values

CONTRIBUTOR

public static final String CONTRIBUTOR

Property name for form last contributor

See Also:

• Constant Field Values

CREATIONDATE

public static final String CREATIONDATE

Property name for form creation date

See Also:

• Constant Field Values

LASTMODIFICATIONDATE

public static final String LASTMODIFICATIONDATE

Property name for form last modification date

See Also:

• Constant Field Values

WORKFLOWNAME

public static final String WORKFLOWNAME

Property name for form workflow name

See Also:

• Constant Field Values

LIMIT_TO_ONE_ENTRY_BY_USER

public static final String LIMIT_TO_ONE_ENTRY_BY_USER

Property name for form to limit one entry by user

See Also:

• Constant Field Values

LIMIT_ENTRIES_ENABLED

public static final String LIMIT_ENTRIES_ENABLED

Property name for form to limit the entries

See Also:

• Constant Field Values

QUEUE_ENABLED

public static final String QUEUE_ENABLED

Property name for form to enable queue

See Also:

• Constant Field Values

QUEUE_SIZE

public static final String QUEUE_SIZE

Property name for form's queue size

See Also:

• Constant Field Values

QUEUE_CLOSED_MSG

public static final String QUEUE_CLOSED_MSG

Property name for form displayed message when closed because of limited number of entries and a queue is enabled

See Also:

• Constant Field Values

MAX_ENTRIES

public static final String MAX_ENTRIES

Property name for form's authorized max number of entries

See Also:

• Constant Field Values

REMAINING_MSG

public static final String REMAINING_MSG

Property name for form displayed message when entries are limited in number

See Also:

• Constant Field Values

CLOSED_MSG

public static final String CLOSED_MSG

Property name for form displayed message when closed because of limited number of entries

See Also:

• Constant Field Values

ADMIN_EMAILS

public static final String ADMIN_EMAILS

Property name for form entries admin emails

See Also:

• Constant Field Values

ADMIN_EMAILS_OTHER

public static final String ADMIN_EMAILS_OTHER

Property name for form entries admin emails alternative source

See Also:

• Constant Field Values

ADMIN_EMAIL_LANGUAGE

public static final String ADMIN_EMAIL_LANGUAGE

Property name for form entries admin email language

See Also:

• Constant Field Values

ADMIN_EMAIL_SUBJECT

public static final String ADMIN_EMAIL_SUBJECT

Property name for form entries admin email subject

See Also:

• Constant Field Values

ADMIN_EMAIL_BODY

public static final String ADMIN_EMAIL_BODY

Property name for form entries admin email body

See Also:

• Constant Field Values

RECEIPT_SENDER

public static final String RECEIPT_SENDER

Property name for form acknowledgement of receipt's sender

See Also:

• Constant Field Values

RECEIPT_RECEIVER

public static final String RECEIPT_RECEIVER

Property name for form acknowledgement of receipt's receiver

See Also:

• Constant Field Values

RECEIPT_SUBJECT

public static final String RECEIPT_SUBJECT

Property name for form acknowledgement of receipt's subject

See Also:

• Constant Field Values

RECEIPT_BODY

public static final String RECEIPT_BODY

Property name for form acknowledgement of receipt's body

See Also:

• Constant Field Values

QUEUE_SENDER

public static final String QUEUE_SENDER

Property name for form acknowledgement of queue's sender

See Also:

• Constant Field Values

QUEUE_RECEIVER

public static final String QUEUE_RECEIVER

Property name for form acknowledgement of queue's receiver

See Also:

• Constant Field Values

QUEUE_SUBJECT

public static final String QUEUE_SUBJECT

Property name for form acknowledgement of queue's subject

See Also:

• Constant Field Values

QUEUE_BODY

public static final String QUEUE_BODY

Property name for form acknowledgement of queue's body

See Also:

• Constant Field Values

START_DATE

public static final String START_DATE

Property name for form start date

See Also:

• Constant Field Values

END_DATE

public static final String END_DATE

Property name for form end date

See Also:

• Constant Field Values

EXPIRATION_ENABLED

public static final String EXPIRATION_ENABLED

Property name for form to activate entry expiration

See Also:

• Constant Field Values

EXPIRATION_PERIOD

public static final String EXPIRATION_PERIOD

Property name for form entries expiration period

See Also:

• Constant Field Values

EXPIRATION_POLICY

public static final String EXPIRATION_POLICY

Property name for form to define the action taken after the form entry expiration

See Also:

• Constant Field Values

SEARCH_CRITERIA

public static final String SEARCH_CRITERIA

Property name for form search criteria (stored as JSON)

See Also:

• Constant Field Values

SEARCH_COLUMNS

public static final String SEARCH_COLUMNS

Property name for form search columns

See Also:

• Constant Field Values

SEARCH_INITIAL_SORT_COLUMN

public static final String SEARCH_INITIAL_SORT_COLUMN

Property name for form search initial sort column

See Also:

• Constant Field Values

SEARCH_INITIAL_SORT_ORDER

public static final String SEARCH_INITIAL_SORT_ORDER

Property name for form search initial sort order (ASC or DESC)

See Also:

• Constant Field Values

Constructor Details

Form

public Form(javax.jcr.Node node,
 String parentPath,
 FormFactory factory)

Creates an Form.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the DefaultAmetysObjectFactory which created the AmetysObject

Method Details

setTitle

public void setTitle(String title)

Set the title of this form.

Parameters:

title - the short title

setDescription

public void setDescription(String description)

Set the description of this form.

Parameters:

description - the description

setAuthor

public void setAuthor(UserIdentity author)

Set the author of this form.

Parameters:

author - the author

setContributor

public void setContributor(UserIdentity contributor)

Set the last contributor of this form.

Parameters:

contributor - the last contributor

setCreationDate

public void setCreationDate(ZonedDateTime creationDate)

Set the date of the creation.

Parameters:

creationDate - the last modification date to set.

setLastModificationDate

public void setLastModificationDate(ZonedDateTime lastModificationDate)

Set the date of the last modification.

Parameters:

lastModificationDate - the last modification date to set.

getTitle

public String getTitle()

Get the title of the form

Returns:

The title

getDescription

public String getDescription()

Get the description of the form

Returns:

The description

getAuthor

public UserIdentity getAuthor()

Get the author of the form

Returns:

The author

getContributor

public UserIdentity getContributor()

Get the last contributor of the form

Returns:

The contributor

getCreationDate

public ZonedDateTime getCreationDate()

Get the date of the last modification of the form

Returns:

The date

getLastModificationDate

public ZonedDateTime getLastModificationDate()

Get the date of the last modification of the form

Returns:

The date

getWorkflowName

public String getWorkflowName()

Get the name of the workflow applied to the form

Returns:

The workflow name

setWorkflowName

public void setWorkflowName(String workflowName)

Set the name of the workflow.

Parameters:

workflowName - the name of the workflow to set.

getReceiptSender

public Optional<String> getReceiptSender()

Get the receipt's sender of this form.

Returns:

The receipt's sender

setReceiptSender

public void setReceiptSender(String sender)

Set the receipt's sender of this form.

Parameters:

sender - The receipt's sender

getReceiptReceiver

public Optional<String> getReceiptReceiver()

Get the receipt's receiver of this form.

Returns:

The receipt's receiver

setReceiptReceiver

public void setReceiptReceiver(String receiver)

Set the receipt's receiver of this form.

Parameters:

receiver - The receipt's receiver

getReceiptSubject

public Optional<String> getReceiptSubject()

Get the receipt's subject of this form.

Returns:

The receipt's subject

setReceiptSubject

public void setReceiptSubject(String subject)

Set the receipt's subject of this form.

Parameters:

subject - The receipt's subject

getReceiptBody

public Optional<String> getReceiptBody()

Get the receipt's body of this form.

Returns:

The receipt's body

setReceiptBody

public void setReceiptBody(String body)

Set the receipt's body of this form.

Parameters:

body - The receipt's body

getSearchCriteria

public String getSearchCriteria()

Get the search criteria JSON configuration

Returns:

The search criteria as a JSON string, or empty string if not set

setSearchCriteria

public void setSearchCriteria(String criteriaJson)

Set the search criteria JSON configuration

Parameters:

criteriaJson - The search criteria as a JSON string

getSearchColumns

public String[] getSearchColumns()

Get the search columns

Returns:

The search column names as an array, or empty array if not set

setSearchColumns

public void setSearchColumns(String[] columns)

Set the search columns

Parameters:

columns - The search column names

getSearchInitialSortColumn

public String getSearchInitialSortColumn()

Get the search initial sort column name

Returns:

The search initial sort column name, or empty string if not set

setSearchInitialSortColumn

public void setSearchInitialSortColumn(String column)

Set the search initial sort column name

Parameters:

column - The search initial sort column name

getSearchInitialSortOrder

public String getSearchInitialSortOrder()

Get the search initial sort order

Returns:

The search initial sort order (ASC or DESC), or empty string if not set

setSearchInitialSortOrder

public void setSearchInitialSortOrder(String order)

Set the search initial sort order

Parameters:

order - The search initial sort order (ASC or DESC)

isMiniSurvey

public boolean isMiniSurvey()

Indicate is this form can be considered as a mini survey

Returns:

true if the form as only one question of type list and is limited to one answer by user

isLimitedToOneEntryByUser

public boolean isLimitedToOneEntryByUser()

Get if this form is limited to one entry by user

Returns:

true if the form is limited to one entry by user

limitToOneEntryByUser

public void limitToOneEntryByUser(boolean limit)

Limit or not to one entry by user

Parameters:

limit - true to limit to one entry by user

isEntriesLimited

public boolean isEntriesLimited()

Get if the form entries are limited

Returns:

true if the form entries are limited

limitEntries

public void limitEntries(boolean limitEntries)

Limit or not the entries of the form

Parameters:

limitEntries - true to limit the entries

isQueueEnabled

public boolean isQueueEnabled()

Get if a queue is enabled

Returns:

true if a queue is enabled

enableQueue

public void enableQueue(boolean enabled)

Enable of not the queue

Parameters:

enabled - true to enable the queue

getMaxEntries

public Optional<Long> getMaxEntries()

Get the max number limit for entries in this form

Returns:

the max number

setMaxEntries

public void setMaxEntries(Long max)

Set the max number limit for entries in this form

Parameters:

max - The max number

isExpirationEnabled

public boolean isExpirationEnabled()

Determines if form has an expiration policy for its entries

Returns:

true if form has an expiration policy for its entries

setExpirationPolicy

public void setExpirationPolicy(boolean enabled,
 long expirationPeriod,
 Form.ExpirationPolicy policy)

Set or remove an expiration policy for entries

Parameters:

enabled - true to enable an expiration policy, false otherwise

expirationPeriod - the expiration period in months

policy - the policy

getExpirationPolicy

public Form.ExpirationPolicy getExpirationPolicy()

Get the expiration policy

Returns:

the the expiration policy or null if there is no expiration policy on entries

getExpirationPeriod

public long getExpirationPeriod()

Get the expiration period in number of months

Returns:

the expiration period or -1 if there is no expiration policy on entries

getRemainingMessage

public Optional<String> getRemainingMessage()

Get the message that will be displayed to users when filling the form if a max entries limit is set

Returns:

a message for users

setRemainingMessage

public void setRemainingMessage(String msg)

Set the message that will be displayed to users when filling the form if a max entries limit is set

Parameters:

msg - The message for users

getClosedMessage

public Optional<String> getClosedMessage()

Get the message that will be displayed to users when the entries limit is reached

Returns:

a message for users

setClosedMessage

public void setClosedMessage(String msg)

Set the message that will be displayed to users when the entries limit is reached

Parameters:

msg - The message for users

getQueueSize

public Optional<Long> getQueueSize()

Get the queue max size in this form

Returns:

the max number

setQueueSize

public void setQueueSize(Long max)

Set the queue max size in this form

Parameters:

max - The max number

getClosedQueueMessage

public Optional<String> getClosedQueueMessage()

Get the message that will be displayed to users when the entries limit is reached and a queue is enabled

Returns:

a message for users

setClosedQueueMessage

public void setClosedQueueMessage(String msg)

Set the message that will be displayed to users when the entries limit is reached and a queue is enabled

Parameters:

msg - The message for users

getQueueMailSender

public Optional<String> getQueueMailSender()

Get the email's sender for notifying exit of queue.

Returns:

The email's sender

setQueueMailSender

public void setQueueMailSender(String sender)

Set the email's sender for notifying exit of queue.

Parameters:

sender - The email's sender

getQueueMailReceiver

public Optional<String> getQueueMailReceiver()

Get the email's receiver for notifying exit of queue.

Returns:

The email's receiver

setQueueMailtReceiver

public void setQueueMailtReceiver(String receiver)

Set the email's receiver for notifying exit of queue.

Parameters:

receiver - The email's receiver

getQueueMailSubject

public Optional<String> getQueueMailSubject()

Get the email's subject for notifying exit of queue.

Returns:

The email's subject

setQueueMailSubject

public void setQueueMailSubject(String subject)

Set the email's subject for notifying exit of queue.

Parameters:

subject - The email's subject

getQueueMailBody

public Optional<String> getQueueMailBody()

Get the email's body for notifying exit of queue.

Returns:

The email's body

setQueueMailBody

public void setQueueMailBody(String body)

Set the email's body for notifying exit of queue.

Parameters:

body - The email's body

getAdminEmails

public Optional<String[]> getAdminEmails()

Get the admin emails

Returns:

the admin emails

setAdminEmails

public void setAdminEmails(String[] emails)

Set the admin emails

Parameters:

emails - the admin emails

getOtherAdminEmails

public Optional<String> getOtherAdminEmails()

Get the alternative source for admin emails

Returns:

the other admin emails

setOtherAdminEmails

public void setOtherAdminEmails(String emails)

Set the alternative source for admin emails

Parameters:

emails - the other admin emails source

getAdminEmailLanguage

public Optional<String> getAdminEmailLanguage()

Get the admin email language

Returns:

the admin email language

setAdminEmailLanguage

public void setAdminEmailLanguage(String language)

Set the admin email language

Parameters:

language - the admin email language

getAdminEmailBody

public Optional<String> getAdminEmailBody()

Get the admin email body

Returns:

the admin email body

setAdminEmailBody

public void setAdminEmailBody(String body)

Set the admin email body

Parameters:

body - the admin email body

getAdminEmailSubject

public Optional<String> getAdminEmailSubject()

Get the admin email subject

Returns:

the admin email subject

setAdminEmailSubject

public void setAdminEmailSubject(String subject)

Set the admin email subject

Parameters:

subject - the admin email subject

setStartDate

public void setStartDate(LocalDate date)

Set the start date

Parameters:

date - The start date

getStartDate

public LocalDate getStartDate()

Get the start date

Returns:

The the start date

setEndDate

public void setEndDate(LocalDate date)

Set the end date

Parameters:

date - The end date

getEndDate

public LocalDate getEndDate()

Get the end date

Returns:

The the end date

getSiteName

public String getSiteName()
                   throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site name.

Specified by:

getSiteName in interface SiteAwareAmetysObject

Returns:

this object's site name.

Throws:

AmetysRepositoryException - if an error occurs.

getSite

public Site getSite()
             throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site.

Specified by:

getSite in interface SiteAwareAmetysObject

Returns:

this object's site

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public Form copyTo(ModifiableTraversableAmetysObject parent,
 String name)
            throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public AmetysObject copyTo(ModifiableTraversableAmetysObject parent,
 String name,
 List<String> restrictTo)
                    throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object if it is not in the restriction list. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

restrictTo - A restrict list of CopiableAmetysObject authorized to be copied

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

getPages

public List<FormPage> getPages()
                        throws AmetysRepositoryException

Get the form pages.

Returns:

the form pages.

Throws:

AmetysRepositoryException - if an error occurs when retrieving the pages of the form

hasEntries

public boolean hasEntries()

true if the form has entries

Returns:

true if the form has entries

getEntries

public List<FormEntry> getEntries()
                           throws AmetysRepositoryException

Get the form entries.

Returns:

the form entries.

Throws:

AmetysRepositoryException - if an error occurs when retrieving the entries of the form

getActiveEntries

public List<FormEntry> getActiveEntries()
                                 throws AmetysRepositoryException

Get the active form entries.

Returns:

a list of the active form entries.

Throws:

AmetysRepositoryException - if an error occurs when retrieving the entries of the form

getQuestion

public FormQuestion getQuestion(String name)
                         throws AmetysRepositoryException

Get a question by its name.

Parameters:

name - the question name.

Returns:

the question.

Throws:

AmetysRepositoryException - if an error occurs when retrieving a question of a form

getQuestions

public List<FormQuestion> getQuestions()
                                throws AmetysRepositoryException

Get the form questions.

Returns:

the form questions.

Throws:

AmetysRepositoryException - if an error occurs when retrieving all the questions of a form

isQuestionNameUnique

public boolean isQuestionNameUnique(String uniqueName)

Verify that no question has the same name for form as the current question in this form

Parameters:

uniqueName - name for form of the current question

Returns:

false if id already exist, true if not

findUniqueQuestionName

public String findUniqueQuestionName(String originalName)

Returns a unique question name in the form

Parameters:

originalName - The original name

Returns:

a unique question name

getQuestionsNames

public List<String> getQuestionsNames()

Get all the nameForForms of the questions in this form

Returns:

a list of the names for form

findUniqueQuestionTitle

public String findUniqueQuestionTitle(String originalTitle)

Returns a unique question title in the form

Parameters:

originalTitle - The original title

Returns:

a unique question title

getQuestionsRule

public Map<FormQuestion,Rule> getQuestionsRule(String sourceQuestionId)

Get the rules having sourceQuestionId as sourceId

Parameters:

sourceQuestionId - The source question

Returns:

a map of question target's name for form and associated rule

deleteQuestionsRule

public void deleteQuestionsRule(String sourceQuestionId)

Delete the rules having sourceQuestionId as sourceId

Parameters:

sourceQuestionId - The source question

hasWorkflow

public boolean hasWorkflow()

true if the form has a workflow

Returns:

true if the form has a workflow

canMoveTo

public boolean canMoveTo(AmetysObject newParent)
                  throws AmetysRepositoryException

Description copied from interface: MovableAmetysObject

Test if a move can be a success or if it is impossible (e.g. due to the implementation of the target)

Specified by:

canMoveTo in interface MovableAmetysObject

Parameters:

newParent - See moveTo.

Returns:

true if the move operation may succeed. If false is returned and you call moveTo anyway, you may encontered a RuntimeException (such as UnsupportedOperationException)

Throws:

AmetysRepositoryException - if an error occurs.

moveTo

public void moveTo(AmetysObject newParent,
 boolean renameIfExist)
            throws AmetysRepositoryException,
RepositoryIntegrityViolationException

Description copied from interface: MovableAmetysObject

Move the current object as a new child of the given object. This node will be the last child. You should call canMoveTo to know if this is a supported operation.

Specified by:

moveTo in interface MovableAmetysObject

Parameters:

newParent - The new parent for the current object. Can not be null. Can not be a child of the current node. Must be a TraversableAmetyObject.

renameIfExist - true to rename moved page if a page with same name already exist

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if a page with the same name already exists.

orderBefore

public void orderBefore(AmetysObject siblingNode)
                 throws AmetysRepositoryException

Description copied from interface: MovableAmetysObject

Order a node before another sibling node (or as the last node)

Specified by:

orderBefore in interface MovableAmetysObject

Parameters:

siblingNode - The node that will be the next sibling node of the current node. Must have the same parent as the current node. Can be null to set the current node as the last node.

Throws:

AmetysRepositoryException - if an error occurs.

isCacheable

public boolean isCacheable()

Returns true if the form is cacheable.

Returns:

true if the form is cacheable.