Package org.ametys.plugins.forms.repository

Class FormPageRule

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

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

org.ametys.plugins.forms.repository.FormPageRule

All Implemented Interfaces:

IndexableAmetysObject, ModifiableIndexableAmetysObject, IndexableDataHolder, ModifiableIndexableDataHolder, IndexableJCRAmetysObject, AmetysObject, ModelAwareAmetysObject, ModifiableModelAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, JCRAmetysObject, ModelAwareJCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableAmetysObject, RemovableAmetysObject

public class FormPageRule
extends SimpleIndexableAmetysObject<FormPageRuleFactory>

Class representing a form rule on a page.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FormPageRule.PageRuleType	Type of a page rule.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_OPTION_VALUE	Constant for the date and time of submission attribute.
static final String	ATTRIBUTE_TARGET_ID	Constant for the page id attribute.
static final String	ATTRIBUTE_TYPE	Constant for the rule type attribute.

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

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
FormPageRule(javax.jcr.Node node, String parentPath, FormPageRuleFactory factory)	Creates an FormPageRule.

Method Summary

Modifier and Type	Method	Description
String	getOption()	Get the selected option
String	getPageId()	Get the page to jump or skip.
FormPageRule.PageRuleType	getType()	Get the type
void	setOption(String value)	Set the option value
void	setPageId(String id)	Set the page id
void	setType(FormPageRule.PageRuleType type)	Set the type

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

Field Details

ATTRIBUTE_OPTION_VALUE

public static final String ATTRIBUTE_OPTION_VALUE

Constant for the date and time of submission attribute.

See Also:

• Constant Field Values

ATTRIBUTE_TYPE

public static final String ATTRIBUTE_TYPE

Constant for the rule type attribute.

See Also:

• Constant Field Values

ATTRIBUTE_TARGET_ID

public static final String ATTRIBUTE_TARGET_ID

Constant for the page id attribute.

See Also:

• Constant Field Values

Constructor Details

FormPageRule

public FormPageRule(javax.jcr.Node node,
 String parentPath,
 FormPageRuleFactory factory)

Creates an FormPageRule.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the DefaultAmetysObjectFactory which created the AmetysObject

Method Details

getType

public FormPageRule.PageRuleType getType()

Get the type

Returns:

the type

setType

public void setType(FormPageRule.PageRuleType type)

Set the type

Parameters:

type - the rule type

getPageId

public String getPageId()

Get the page to jump or skip. Can be null.

Returns:

the page to jump or skip

setPageId

public void setPageId(String id)

Set the page id

Parameters:

id - the page id

getOption

public String getOption()

Get the selected option

Returns:

the selected option

setOption

public void setOption(String value)

Set the option value

Parameters:

value - the option value