Package org.ametys.cms.repository

Interface WorkflowAwareContent

All Superinterfaces:

ACLAmetysObject, AmetysObject, Content, DataHolder, DublinCoreAwareAmetysObject, IndexableAmetysObject, IndexableDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModelAwareAmetysObject, ModelAwareDataHolder, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableDataHolder, ModifiableMetadataAwareAmetysObject, RemovableAmetysObject, TagAwareAmetysObject, WorkflowAwareAmetysObject

All Known Subinterfaces:

ModifiableWorkflowAwareContent

All Known Implementing Classes:

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

public interface WorkflowAwareContent
extends Content, WorkflowAwareAmetysObject

Content abstraction defined by the following additional property:

workflowId

the id of the workflow instance associated with the content

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.repository.Content

Content.ReferencingContentsSearch

Field Summary

Fields inherited from interface org.ametys.cms.repository.Content

ATTRIBUTE_TITLE

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

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Method Summary

Modifier and Type	Method	Description
ModifiableIndexableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
Optional<? extends ModifiableIndexableDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
default ZonedDateTime	getProposalDate()	Retrieves the date at which the content was proposed for validation, i.e.
ModifiableIndexableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
default ModifiableDataHolder	getWorkflowMetadataHolder()	Retrieves the DataHolder containing the workflow metadata of the Ametys object.
default void	setProposalDate(ZonedDateTime proposalDate)	Set the date at which the content was proposed for validation, i.e.

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

getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, isInheritanceDisallowed

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

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

Methods inherited from interface org.ametys.cms.repository.Content

getCreationDate, getCreator, getFirstValidationDate, getFirstValidator, getInternalDataHolder, getLanguage, getLastContributor, getLastMajorValidationDate, getLastMajorValidator, getLastModified, getLastValidationDate, getLastValidator, getMixinTypes, getOutgoingReferences, getReferencingContents, getRootAttachments, getTitle, getTitle, getTypes, hasReferencingContents, searchReferencingContents, setLanguage, setMixinTypes, setType, setTypes, toSAX

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.plugins.repository.dublincore.DublinCoreAwareAmetysObject

getDCContributor, getDCCoverage, getDCCreator, getDCDate, getDCDescription, getDCFormat, getDCIdentifier, getDCLanguage, getDCPublisher, getDCRelation, getDCRights, getDCSource, getDCSubject, getDCTitle, getDCType

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

getSystemPropertyExtensionPoint, indexData, indexData

Methods inherited from interface org.ametys.cms.data.holder.IndexableDataHolder

getExternalComposite, getExternalRepeater, getLocalComposite, getLocalRepeater, getRepeater

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.ModifiableACLAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, disallowInheritance, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

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

Methods inherited from interface org.ametys.plugins.repository.tag.TagAwareAmetysObject

getTags

Methods inherited from interface org.ametys.plugins.workflow.repository.WorkflowAwareAmetysObject

getCurrentStepId, getWorkflowId, setCurrentStepId, setWorkflowId

Method Details

getProposalDate

default ZonedDateTime getProposalDate()
                               throws AmetysRepositoryException

Retrieves the date at which the content was proposed for validation, i.e. put in a workflow step in which it's awaiting validation.

Returns:

the date at which the content was proposed for validation.

Throws:

AmetysRepositoryException - if an error occurs.

setProposalDate

default void setProposalDate(ZonedDateTime proposalDate)
                      throws AmetysRepositoryException

Set the date at which the content was proposed for validation, i.e. put in a workflow step in which it's awaiting validation.

Parameters:

proposalDate - the date at which the content was proposed for validation, or null to remove it.

Throws:

AmetysRepositoryException - if an error occurs.

getWorkflowMetadataHolder

default ModifiableDataHolder getWorkflowMetadataHolder()

Description copied from interface: WorkflowAwareAmetysObject

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

Specified by:

getWorkflowMetadataHolder in interface WorkflowAwareAmetysObject

Returns:

the DataHolder containing the workflow metadata of the Ametys object.

getComposite

ModifiableIndexableComposite getComposite(String compositePath)
                                   throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface IndexableDataHolder

Specified by:

getComposite in interface ModelAwareDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the stored value at the given path is not a composite

UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model

BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple

getParentDataHolder

Optional<? extends ModifiableIndexableDataHolder> getParentDataHolder()

Description copied from interface: DataHolder

Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root

Specified by:

getParentDataHolder in interface DataHolder

Specified by:

getParentDataHolder in interface IndexableDataHolder

Specified by:

getParentDataHolder in interface ModelAwareDataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

ModifiableIndexableDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface IndexableDataHolder

Specified by:

getRootDataHolder in interface ModelAwareDataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Returns:

the root DataHolder