Package org.ametys.plugins.forms.repository

Class FormEntry

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

org.ametys.plugins.forms.repository.FormEntry

All Implemented Interfaces:

ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, IndexableDataHolder, ModifiableIndexableDataHolder, AmetysObject, DataAwareAmetysObject, ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableAmetysObject, RemovableAmetysObject, WorkflowAwareAmetysObject

public class FormEntry
extends SimpleAmetysObject<FormEntryFactory>
implements ModifiableModelAwareDataAwareAmetysObject, WorkflowAwareAmetysObject

Class representing a form entry, backed by a JCR node.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_ACTIVE	Constant for active status of entry.
static final String	ATTRIBUTE_ID	Constant for id of an entry.
static final String	ATTRIBUTE_IP	The IP address of the person who answered the form.
static final String	ATTRIBUTE_SUBMIT_DATE	Constant for the date and time of submission attribute.
static final String	ATTRIBUTE_USER	The id of the user who answered the form.
static final String	SYSTEM_ATTRIBUTE_PREFIX	Constant for entry attribute prefix.

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

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
FormEntry(javax.jcr.Node node, String parentPath, FormEntryFactory factory)	Creates an FormEntry.

Method Summary

Modifier and Type	Method	Description
long	getCurrentStepId()	Retrieves the current step id of the Ametys object
ModifiableIndexableDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
Long	getEntryId()	Retrieves the id.
Form	getForm()	Get form
String	getIP()	Retrieves the ip.
ZonedDateTime	getSubmitDate()	Retrieves the submitDate.
UserIdentity	getUser()	Get the identity of the user answering the form
long	getWorkflowId()	Retrieves the workflow id associated with the Ametys object.
Boolean	isActive()	Get active status of the entry
void	setActive(Boolean isActive)	Set active status of the entry
void	setCurrentStepId(long stepId)	Set the current step id of the Ametys object
void	setEntryId(Long id)	Set the id.
void	setIP(String ip)	Set the ip.
void	setSubmitDate(ZonedDateTime submitDate)	Set the submitDate.
void	setUser(UserIdentity user)	Set the identity of the user answering the form
void	setWorkflowId(long workflowId)	Set the workflow id of this Ametys object. This method will throw Exception if the workflow id was already set on this Ametys object.

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

equals, 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.ametysobject.DataAwareAmetysObject

copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX

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

getNode

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

getSystemPropertyExtensionPoint, indexData, indexData

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

dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty

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

commentsToSAX, dataToJSON, dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, getDataNames, getType, getValue, hasValue, hasValueOrEmpty, 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

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

getMetadataHolder

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

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

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

getRepositoryData, removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, removeValue, setComments, setExternalValue, setLocalValue, setStatus, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues

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

remove

Field Details

SYSTEM_ATTRIBUTE_PREFIX

public static final String SYSTEM_ATTRIBUTE_PREFIX

Constant for entry attribute prefix.

See Also:

• Constant Field Values

ATTRIBUTE_ID

public static final String ATTRIBUTE_ID

Constant for id of an entry.

See Also:

• Constant Field Values

ATTRIBUTE_SUBMIT_DATE

public static final String ATTRIBUTE_SUBMIT_DATE

Constant for the date and time of submission attribute.

See Also:

• Constant Field Values

ATTRIBUTE_IP

public static final String ATTRIBUTE_IP

The IP address of the person who answered the form.

See Also:

• Constant Field Values

ATTRIBUTE_USER

public static final String ATTRIBUTE_USER

The id of the user who answered the form.

See Also:

• Constant Field Values

ATTRIBUTE_ACTIVE

public static final String ATTRIBUTE_ACTIVE

Constant for active status of entry. Default is true

See Also:

• Constant Field Values

Constructor Details

FormEntry

public FormEntry(javax.jcr.Node node,
 String parentPath,
 FormEntryFactory factory)

Creates an FormEntry.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the DefaultAmetysObjectFactory which created the AmetysObject

Method Details

getForm

public Form getForm()

Get form

Returns:

the form

getEntryId

public Long getEntryId()

Retrieves the id.

Returns:

the id.

setEntryId

public void setEntryId(Long id)

Set the id.

Parameters:

id - the id.

getIP

public String getIP()

Retrieves the ip.

Returns:

the ip.

setIP

public void setIP(String ip)

Set the ip.

Parameters:

ip - the ip.

getSubmitDate

public ZonedDateTime getSubmitDate()

Retrieves the submitDate.

Returns:

the submitDate.

setSubmitDate

public void setSubmitDate(ZonedDateTime submitDate)

Set the submitDate.

Parameters:

submitDate - the submitDate.

setUser

public void setUser(UserIdentity user)

Set the identity of the user answering the form

Parameters:

user - the user identity

isActive

public Boolean isActive()

Get active status of the entry

Returns:

the active status

setActive

public void setActive(Boolean isActive)

Set active status of the entry

Parameters:

isActive - the active status

getUser

public UserIdentity getUser()

Get the identity of the user answering the form

Returns:

the user identity

getWorkflowId

public long getWorkflowId()
                   throws AmetysRepositoryException

Description copied from interface: WorkflowAwareAmetysObject

Retrieves the workflow id associated with the Ametys object.

Specified by:

getWorkflowId in interface WorkflowAwareAmetysObject

Returns:

the workflow id.

Throws:

AmetysRepositoryException - if an error occurs.

setWorkflowId

public void setWorkflowId(long workflowId)
                   throws AmetysRepositoryException

Description copied from interface: WorkflowAwareAmetysObject

Set the workflow id of this Ametys object.
This method will throw Exception if the workflow id was already set on this Ametys object.

Specified by:

setWorkflowId in interface WorkflowAwareAmetysObject

Parameters:

workflowId - the workflow id of the object.

Throws:

AmetysRepositoryException - if an error occurs.

getCurrentStepId

public long getCurrentStepId()
                      throws AmetysRepositoryException

Description copied from interface: WorkflowAwareAmetysObject

Retrieves the current step id of the Ametys object

Specified by:

getCurrentStepId in interface WorkflowAwareAmetysObject

Returns:

the current step id

Throws:

AmetysRepositoryException - if an error occurs.

setCurrentStepId

public void setCurrentStepId(long stepId)
                      throws AmetysRepositoryException

Description copied from interface: WorkflowAwareAmetysObject

Set the current step id of the Ametys object

Specified by:

setCurrentStepId in interface WorkflowAwareAmetysObject

Parameters:

stepId - the step id to set

Throws:

AmetysRepositoryException - if an error occurs.

getDataHolder

public ModifiableIndexableDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelAwareDataAwareAmetysObject

Specified by:

getDataHolder in interface ModelAwareDataAwareAmetysObject

Specified by:

getDataHolder in interface ModifiableModelAwareDataAwareAmetysObject

Specified by:

getDataHolder in interface ModifiableModelAwareDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject