Package org.ametys.plugins.workflow.repository

Interface WorkflowAwareAmetysObject

All Superinterfaces:

AmetysObject, DataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableAmetysObject, ModifiableDataHolder, ModifiableMetadataAwareAmetysObject, RemovableAmetysObject

All Known Subinterfaces:

ModifiableWorkflowAwareContent, WorkflowAwareContent

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Container, Course, CourseList, CoursePart, DefaultWorkflowAwareContent, FormEntry, JCRCalendarEvent, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, SubProgram

public interface WorkflowAwareAmetysObject
extends JCRAmetysObject

AmetysObject abstraction defined by the following additional property:

workflowId

the id of the workflow instance associated with the ametys object

currentStepId

the id of the current step associated with the ametys object

Method Summary

Modifier and Type	Method	Description
default long	getCurrentStepId()	Retrieves the current step id of the Ametys object
default long	getWorkflowId()	Retrieves the workflow id associated with the Ametys object.
ModifiableDataHolder	getWorkflowMetadataHolder()	Retrieves the DataHolder containing the workflow metadata of the Ametys object.
default void	setCurrentStepId(long stepId)	Set the current step id of the Ametys object
default 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 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, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

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

getNode

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

needsSave, rename, revertChanges, saveChanges

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

getComposite, getComposite, getParentDataHolder, getRepositoryData, getRootDataHolder, removeValue, setValue, setValue, synchronizeValues

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

getMetadataHolder

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

remove

Method Details

getWorkflowId

default long getWorkflowId()
                    throws AmetysRepositoryException

Retrieves the workflow id associated with the Ametys object.

Returns:

the workflow id.

Throws:

AmetysRepositoryException - if an error occurs.

setWorkflowId

default void setWorkflowId(long workflowId)
                    throws AmetysRepositoryException

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

Parameters:

workflowId - the workflow id of the object.

Throws:

AmetysRepositoryException - if an error occurs.

getCurrentStepId

default long getCurrentStepId()
                       throws AmetysRepositoryException

Retrieves the current step id of the Ametys object

Returns:

the current step id

Throws:

AmetysRepositoryException - if an error occurs.

setCurrentStepId

default void setCurrentStepId(long stepId)
                       throws AmetysRepositoryException

Set the current step id of the Ametys object

Parameters:

stepId - the step id to set

Throws:

AmetysRepositoryException - if an error occurs.

getWorkflowMetadataHolder

ModifiableDataHolder getWorkflowMetadataHolder()

Retrieves the DataHolder containing the workflow metadata of the Ametys object.

Returns:

the DataHolder containing the workflow metadata of the Ametys object.