Package org.ametys.plugins.forms.repository

Class FormQuestion

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

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

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

org.ametys.plugins.forms.repository.FormQuestion

All Implemented Interfaces:

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

public class FormQuestion
extends DefaultIndexableTraversableAmetysObject<FormQuestionFactory>
implements SiteAwareAmetysObject

AmetysObject for storing form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_NAME_FOR_FORM	Constant for default identifier attribute.
static final String	ATTRIBUTE_PAGE_ID	Constant for page id attribute.
static final String	ATTRIBUTE_RULE	Constant for rule attribute.
static final String	ATTRIBUTE_RULES	Constant for rules repeater.
static final String	ATTRIBUTE_TITLE	Constant for title attribute.
static final String	ATTRIBUTE_TYPE	Constant for type attribute.

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
FormQuestion(javax.jcr.Node node, String parentPath, FormQuestionFactory factory)	Creates a FormQuestion.

Method Summary

Modifier and Type	Method	Description
void	addPageRules(String option, FormPageRule.PageRuleType ruleType, String pageId)	Add a page rule for branching
boolean	canRead(Long currentStep)	Determines if we can read the question for the current step.
boolean	canWrite(Long currentStep)	Determines if we can write the question for the current step.
void	copyTo(ModifiableDataHolder dataHolder)	Copies the current DataHolder to the given ModifiableDataHolder.
void	deletePageRule(String option)	Delete a rule
Optional<Rule>	getFirstQuestionRule()	Get the first question rule
Form	getForm()	Get the form to which this question belongs.
FormPage	getFormPage()	Get the page to which this question belongs.
String	getNameForForm()	Retrieves the name for form.
List<FormPageRule>	getPageRules()	Get the page rules
List<Rule>	getQuestionRules()	Get the question rules
Site	getSite()	Returns this object's site.
String	getSiteName()	Returns this object's site name.
String	getTitle()	Retrieves the title.
FormQuestionType	getType()	Retrieves the type.
boolean	hasPageRule(String option)	Determines if a rule with given option exists
boolean	isCacheable()	Returns true if the question is cacheable.
boolean	isMandatory()	Determines if the question is mandatory.
boolean	isModifiable()	Determines if the question is modifiable
boolean	isReadRestricted()	Determines if the question is read restricted.
void	setNameForForm(String name)	Set the name for form.
void	setTitle(String title)	Set the title.
void	setTypeId(String typeId)	Set the type id.
void	setTypeId(FormQuestionType type)	Set the type id.

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, 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

ATTRIBUTE_PAGE_ID

public static final String ATTRIBUTE_PAGE_ID

Constant for page id attribute.

See Also:

• Constant Field Values

ATTRIBUTE_TITLE

public static final String ATTRIBUTE_TITLE

Constant for title attribute.

See Also:

• Constant Field Values

ATTRIBUTE_NAME_FOR_FORM

public static final String ATTRIBUTE_NAME_FOR_FORM

Constant for default identifier attribute.

See Also:

• Constant Field Values

ATTRIBUTE_TYPE

public static final String ATTRIBUTE_TYPE

Constant for type attribute.

See Also:

• Constant Field Values

ATTRIBUTE_RULES

public static final String ATTRIBUTE_RULES

Constant for rules repeater.

See Also:

• Constant Field Values

ATTRIBUTE_RULE

public static final String ATTRIBUTE_RULE

Constant for rule attribute.

See Also:

• Constant Field Values

Constructor Details

FormQuestion

public FormQuestion(javax.jcr.Node node,
 String parentPath,
 FormQuestionFactory factory)

Creates a FormQuestion.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the FormFactory which creates the AmetysObject.

Method Details

getFormPage

public FormPage getFormPage()
                     throws AmetysRepositoryException

Get the page to which this question belongs.

Returns:

the page to which this question belongs.

Throws:

AmetysRepositoryException - if a repository error occurs when retrieving the page attached to a form

getForm

public Form getForm()
             throws AmetysRepositoryException

Get the form to which this question belongs.

Returns:

the form to which this question belongs.

Throws:

AmetysRepositoryException - if a repository error occurs when retrieving a form

getType

public FormQuestionType getType()

Retrieves the type.

Returns:

the type.

setTypeId

public void setTypeId(String typeId)

Set the type id.

Parameters:

typeId - the type id.

setTypeId

public void setTypeId(FormQuestionType type)

Set the type id.

Parameters:

type - the type.

getNameForForm

public String getNameForForm()

Retrieves the name for form.

Returns:

the name for form.

setNameForForm

public void setNameForForm(String name)

Set the name for form.

Parameters:

name - the name for form.

getTitle

public String getTitle()

Retrieves the title.

Returns:

the title.

setTitle

public void setTitle(String title)

Set the title.

Parameters:

title - the title.

isMandatory

public boolean isMandatory()

Determines if the question is mandatory. (If the user has to answer it)

Returns:

true if the question is mandatory.

isReadRestricted

public boolean isReadRestricted()

Determines if the question is read restricted.

Returns:

true if the question is read restricted.

canRead

public boolean canRead(Long currentStep)

Determines if we can read the question for the current step.

Parameters:

currentStep - the current step of the form entry

Returns:

true if we can read the question for the current step.

isModifiable

public boolean isModifiable()

Determines if the question is modifiable

Returns:

true if the question is modifiable.

canWrite

public boolean canWrite(Long currentStep)

Determines if we can write the question for the current step.

Parameters:

currentStep - the current step of the form entry

Returns:

true if we can write the question for the current step.

getQuestionRules

public List<Rule> getQuestionRules()

Get the question rules

Returns:

A RuleTypeQuestion's name

getFirstQuestionRule

public Optional<Rule> getFirstQuestionRule()

Get the first question rule

Returns:

A RuleTypeQuestion's name

getPageRules

public List<FormPageRule> getPageRules()
                                throws AmetysRepositoryException

Get the page rules

Returns:

the page rules

Throws:

AmetysRepositoryException - if an error occurs.

hasPageRule

public boolean hasPageRule(String option)
                    throws AmetysRepositoryException

Determines if a rule with given option exists

Parameters:

option - the option

Returns:

true if the rule exists

Throws:

AmetysRepositoryException - if an error occurs.

addPageRules

public void addPageRules(String option,
 FormPageRule.PageRuleType ruleType,
 String pageId)

Add a page rule for branching

Parameters:

option - the chosen option

ruleType - the page rule type

pageId - Id of the page to jump or skip. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

deletePageRule

public void deletePageRule(String option)
                    throws AmetysRepositoryException

Delete a rule

Parameters:

option - the option to delete

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public void copyTo(ModifiableDataHolder dataHolder)
            throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Copies the current DataHolder to the given ModifiableDataHolder.

Specified by:

copyTo in interface DataHolder

Parameters:

dataHolder - The destination dataHolder. Can not be null.

Throws:

UnknownTypeException - if there is no available type compatible with the copied value for the type extension point of the destination ModifiableDataHolder

NotUniqueTypeException - if there is more than one available types compatibles with the copied value for the type extension point of the destination ModifiableDataHolder

BadItemTypeException - if type of a data to copy doesn't match the data with same path in the destination ModifiableDataHolder

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.

isCacheable

public boolean isCacheable()

Returns true if the question is cacheable.

Returns:

true if the question is cacheable.