Package org.ametys.cms.repository

Class ModifiableDefaultContent<F extends ModifiableContentFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

org.ametys.plugins.repository.jcr.DefaultAmetysObject<F>

org.ametys.cms.repository.DefaultContent<F>

org.ametys.cms.repository.ModifiableDefaultContent<F>

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, IndexableDataHolder, ModifiableIndexableDataHolder, CommentableContent, ContributorCommentableAmetysObject, ContributorCommentableContent, CommentableAmetysObject<Comment>, Content, ModifiableContent, ModifiableWorkflowAwareContent, ReactionableObject, ReportableObject, WorkflowAwareContent, ACLAmetysObject, AmetysObject, CopiableAmetysObject, DataAwareAmetysObject, ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, DublinCoreAwareAmetysObject, ModifiableDublinCoreAwareAmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, LockableAmetysObject, LockAwareAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TagAwareAmetysObject, TaggableAmetysObject, TraversableAmetysObject, DataAndVersionAwareAmetysObject, ModifiableDataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject, WorkflowAwareAmetysObject

Direct Known Subclasses:

AbstractProgramPart, Course, CoursePart, OrgUnit, Person

public class ModifiableDefaultContent<F extends ModifiableContentFactory>
extends DefaultContent<F>
implements CommentableContent, ContributorCommentableContent, LockableAmetysObject, ModifiableWorkflowAwareContent

Default implementation of a Content, also versionable, lockable and workflow-aware.

Nested Class Summary

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

Content.ReferencingContentsSearch

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

ReactionableObject.ReactionType

Field Summary

Fields inherited from class org.ametys.cms.repository.DefaultContent

_mixins, _outgoingReferences, _types, ATTACHMENTS_NODE_NAME, DEFAULT_CONTENT_LOCALE, METADATA_CONTENTTYPE, METADATA_CONTRIBUTOR, METADATA_CREATION, METADATA_CREATOR, METADATA_FIRST_VALIDATION, METADATA_FIRST_VALIDATOR, METADATA_LANGUAGE, METADATA_LAST_MAJOR_VALIDATOR, METADATA_LAST_MAJORVALIDATION, METADATA_LAST_VALIDATION, METADATA_LAST_VALIDATOR, METADATA_MIXINCONTENTTYPES, METADATA_MODIFIED, METADATA_OUTGOING_REFERENCE_NODETYPE, METADATA_OUTGOING_REFERENCE_PROPERTY, METADATA_OUTGOING_REFERENCES, METADATA_OUTGOING_REFERENCES_PATH_PROPERTY, METADATA_ROOT_OUTGOING_REFERENCES

Fields inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

__VERSION_COMPARATOR, PROTECTED_PROPERTIES

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

ATTRIBUTE_TITLE

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

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
ModifiableDefaultContent(javax.jcr.Node node, String parentPath, F factory)	Creates a JCR-based Content.

Method Summary

Modifier and Type	Method	Description
Comment	createComment()	Creates a comment
Comment	createComment(String commentId, ZonedDateTime creationDate)	Creates a comment with the given id and creation date This method allow to create a comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted.
Comment	createContributorComment()	Creates a contributor comment
Comment	createContributorComment(String commentId, ZonedDateTime creationDate)	Creates a contributor comment with the given id and creation date This method allow to create a contributor comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted.
void	fillContent(Node node, XMLValuesExtractorAdditionalDataGetter additionalDataGetter)	Fills the current content with the values from the provided Node.
Comment	getComment(String commentId)	Get a comment
List<Comment>	getComments(boolean includeNotValidatedComments, boolean includeValidatedComments)	Get the list of available comments (validated, not validated, both or none :))
Comment	getContributorComment(String commentId)	Get a contributor comment
List<Comment>	getContributorComments()	Get the list of available contributor comments
long	getCurrentStepId()	Retrieves the current step id of the Ametys object
ModifiableContentDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
UserIdentity	getLockOwner()	Returns the owner of the lock, or null if none
ZonedDateTime	getProposalDate()	Retrieves the date at which the content was proposed for validation, i.e.
long	getWorkflowId()	Retrieves the workflow id associated with the Ametys object.
boolean	isLocked()	Returns true if this AmetysObject is locked
void	lock()	Locks this AmetysObject
void	setCreationDate(ZonedDateTime creationDate)	Set the creation date.
void	setCreator(UserIdentity user)	Set the login of the creator.
void	setCurrentStepId(long stepId)	Set the current step id of the Ametys object
void	setDCContributor(String contributor)	Set the Dublin Core contributor.
void	setDCCoverage(String coverage)	Set the Dublin Core coverage.
void	setDCCreator(String creator)	Set the Dublin Core creator.
void	setDCDate(Date date)	Set the Dublin Core date.
void	setDCDescription(String description)	Set the Dublin Core description.
void	setDCFormat(String format)	Set the Dublin Core format.
void	setDCIdentifier(String identifier)	Set the Dublin Core identifier.
void	setDCLanguage(String language)	Set the Dublin Core language.
void	setDCPublisher(String publisher)	Set the Dublin Core publisher.
void	setDCRelation(String relation)	Set the Dublin Core relation.
void	setDCRights(String rights)	Set the Dublin Core rights.
void	setDCSource(String source)	Set the Dublin Core source.
void	setDCSubject(String[] subject)	Set the Dublin Core subject.
void	setDCTitle(String title)	Set the Dublin Core title.
void	setDCType(String type)	Set the Dublin Core type.
void	setFirstValidationDate(ZonedDateTime validationDate)	Set the first validation date
void	setFirstValidator(UserIdentity user)	Set the identity of the first validator.
void	setLastContributor(UserIdentity user)	Set the login of the last contributor.
void	setLastMajorValidationDate(ZonedDateTime validationDate)	Set the last validation date resulting from a major modification
void	setLastMajorValidator(UserIdentity user)	Set the identity of the last major validator.
void	setLastModified(ZonedDateTime lastModified)	Set the last modification date.
void	setLastValidationDate(ZonedDateTime validationDate)	Set the last validation date
void	setLastValidator(UserIdentity user)	Set the identity of the last validator.
void	setLockInfoOnCurrentContext()	Sets a lock info on the current context for this object
void	setOutgoingReferences(Map<String,OutgoingReferences> references)	Store the outgoing references of the content.
void	setProposalDate(ZonedDateTime proposalDate)	Set the date at which the content was proposed for validation, i.e.
void	setTitle(String title)	Set the title.
void	setTitle(String title, Locale locale)	Set the title from the given locale
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.
void	tag(String tag)	Tags.
void	unlock()	Unlocks this AmetysObject
void	untag(String tag)	Untags.

Methods inherited from class org.ametys.cms.repository.DefaultContent

addReaction, addReport, clearReports, copyTo, copyTo, copyTo, copyTo, createChild, getChild, getChildren, getCreationDate, getCreator, getDCContributor, getDCCoverage, getDCCreator, getDCDate, getDCDescription, getDCFormat, getDCIdentifier, getDCLanguage, getDCPublisher, getDCRelation, getDCRights, getDCSource, getDCSubject, getDCTitle, getDCType, getFirstValidationDate, getFirstValidator, getInternalDataHolder, getLanguage, getLastContributor, getLastMajorValidationDate, getLastMajorValidator, getLastModified, getLastValidationDate, getLastValidator, getMixinTypes, getOutgoingReferences, getReactionUsers, getReferencingContents, getReportsCount, getRootAttachments, getSystemPropertyExtensionPoint, getTags, getTitle, getTitle, getTypes, hasChild, hasReferencingContents, removeReaction, searchReferencingContents, setLanguage, setMixinTypes, setReportsCount, setType, setTypes, toSAX

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, addLabel, checkpoint, copyNode, disallowInheritance, getAllLabels, getAllRevisions, getBaseNode, getBaseVersion, getLabels, getLabels, getNode, getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, getRevision, getRevisionTimestamp, getRevisionTimestamp, getUnversionedDataHolder, getVersionHistory, isInheritanceDisallowed, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers, removeLabel, restoreFromLabel, restoreFromNode, restoreFromRevision, switchToLabel, switchToRevision

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, 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.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.ametysobject.DataAwareAmetysObject

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX

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.plugins.repository.jcr.JCRAmetysObject

getNode

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

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

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

dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, 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.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

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

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

getTags

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

getChildAt, getChildPosition

Constructor Details

ModifiableDefaultContent

public ModifiableDefaultContent(javax.jcr.Node node,
 String parentPath,
 F factory)

Creates a JCR-based Content.

Parameters:

node - the JCR Node backing this Content.

parentPath - the parent path in the Ametys hierarchy.

factory - the corresponding ContentFactory.

Method Details

setTitle

public void setTitle(String title,
 Locale locale)
              throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the title from the given locale

Specified by:

setTitle in interface ModifiableContent

Parameters:

title - the title.

locale - The locale

Throws:

AmetysRepositoryException - if an error occurs.

setTitle

public void setTitle(String title)
              throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the title. Be careful ! Use only if content's title is not a multilingual string. If not sure use ModifiableContent.setTitle(String, Locale) instead.

Specified by:

setTitle in interface ModifiableContent

Parameters:

title - the title.

Throws:

AmetysRepositoryException - if an error occurs.

setCreator

public void setCreator(UserIdentity user)
                throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the login of the creator.

Specified by:

setCreator in interface ModifiableContent

Parameters:

user - the creator.

Throws:

AmetysRepositoryException - if an error occurs.

setCreationDate

public void setCreationDate(ZonedDateTime creationDate)
                     throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the creation date.

Specified by:

setCreationDate in interface ModifiableContent

Parameters:

creationDate - the creation date.

Throws:

AmetysRepositoryException - if an error occurs.

setLastContributor

public void setLastContributor(UserIdentity user)

Description copied from interface: ModifiableContent

Set the login of the last contributor.

Specified by:

setLastContributor in interface ModifiableContent

Parameters:

user - the last contributor.

setLastModified

public void setLastModified(ZonedDateTime lastModified)
                     throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the last modification date.

Specified by:

setLastModified in interface ModifiableContent

Parameters:

lastModified - the last modification date.

Throws:

AmetysRepositoryException - if an error occurs.

setFirstValidator

public void setFirstValidator(UserIdentity user)
                       throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the identity of the first validator.

Specified by:

setFirstValidator in interface ModifiableContent

Parameters:

user - the first validator.

Throws:

AmetysRepositoryException - if an error occurs.

setFirstValidationDate

public void setFirstValidationDate(ZonedDateTime validationDate)
                            throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the first validation date

Specified by:

setFirstValidationDate in interface ModifiableContent

Parameters:

validationDate - the validation date.

Throws:

AmetysRepositoryException - if an error occurs.

setLastValidator

public void setLastValidator(UserIdentity user)
                      throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the identity of the last validator.

Specified by:

setLastValidator in interface ModifiableContent

Parameters:

user - the last validator.

Throws:

AmetysRepositoryException - if an error occurs.

setLastValidationDate

public void setLastValidationDate(ZonedDateTime validationDate)
                           throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the last validation date

Specified by:

setLastValidationDate in interface ModifiableContent

Parameters:

validationDate - the validation date.

Throws:

AmetysRepositoryException - if an error occurs.

setLastMajorValidator

public void setLastMajorValidator(UserIdentity user)
                           throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the identity of the last major validator.

Specified by:

setLastMajorValidator in interface ModifiableContent

Parameters:

user - the last major validator.

Throws:

AmetysRepositoryException - if an error occurs.

setLastMajorValidationDate

public void setLastMajorValidationDate(ZonedDateTime validationDate)
                                throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Set the last validation date resulting from a major modification

Specified by:

setLastMajorValidationDate in interface ModifiableContent

Parameters:

validationDate - the validation date.

Throws:

AmetysRepositoryException - if an error occurs.

setOutgoingReferences

public void setOutgoingReferences(Map<String,OutgoingReferences> references)
                           throws AmetysRepositoryException

Description copied from interface: ModifiableContent

Store the outgoing references of the content.

Specified by:

setOutgoingReferences in interface ModifiableContent

Parameters:

references - A non null map of outgoing references grouped by metadata (key are metadata path)

Throws:

AmetysRepositoryException - if an error occurs.

tag

public void tag(String tag)
         throws AmetysRepositoryException

Description copied from interface: TaggableAmetysObject

Tags.

Specified by:

tag in interface TaggableAmetysObject

Parameters:

tag - the tag to add.

Throws:

AmetysRepositoryException - if an error occurs.

untag

public void untag(String tag)
           throws AmetysRepositoryException

Description copied from interface: TaggableAmetysObject

Untags.

Specified by:

untag in interface TaggableAmetysObject

Parameters:

tag - the tag to remove.

Throws:

AmetysRepositoryException - if an error occurs.

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.

getProposalDate

public ZonedDateTime getProposalDate()
                              throws AmetysRepositoryException

Description copied from interface: WorkflowAwareContent

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

Specified by:

getProposalDate in interface WorkflowAwareContent

Returns:

the date at which the content was proposed for validation.

Throws:

AmetysRepositoryException - if an error occurs.

setProposalDate

public void setProposalDate(ZonedDateTime proposalDate)
                     throws AmetysRepositoryException

Description copied from interface: WorkflowAwareContent

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

Specified by:

setProposalDate in interface WorkflowAwareContent

Parameters:

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

Throws:

AmetysRepositoryException - if an error occurs.

lock

public void lock()
          throws AmetysRepositoryException

Description copied from interface: LockableAmetysObject

Locks this AmetysObject

Specified by:

lock in interface LockableAmetysObject

Throws:

AmetysRepositoryException - if a problem occurs

unlock

public void unlock()
            throws AmetysRepositoryException

Description copied from interface: LockableAmetysObject

Unlocks this AmetysObject

Specified by:

unlock in interface LockableAmetysObject

Throws:

AmetysRepositoryException - if a problem occurs

setLockInfoOnCurrentContext

public void setLockInfoOnCurrentContext()
                                 throws AmetysRepositoryException

Description copied from interface: LockableAmetysObject

Sets a lock info on the current context for this object

Specified by:

setLockInfoOnCurrentContext in interface LockableAmetysObject

Throws:

AmetysRepositoryException - if an error occurs

isLocked

public boolean isLocked()
                 throws AmetysRepositoryException

Description copied from interface: LockAwareAmetysObject

Returns true if this AmetysObject is locked

Specified by:

isLocked in interface LockAwareAmetysObject

Returns:

true if this AmetysObject is locked

Throws:

AmetysRepositoryException - if a problem occurs

getLockOwner

public UserIdentity getLockOwner()
                          throws AmetysRepositoryException

Description copied from interface: LockAwareAmetysObject

Returns the owner of the lock, or null if none

Specified by:

getLockOwner in interface LockAwareAmetysObject

Returns:

the owner of the lock, or null if none

Throws:

AmetysRepositoryException - if a problem occurs

setDCTitle

public void setDCTitle(String title)
                throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core title.

Specified by:

setDCTitle in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

title - the Dublin Core title to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCCreator

public void setDCCreator(String creator)
                  throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core creator.

Specified by:

setDCCreator in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

creator - the Dublin Core creator to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCSubject

public void setDCSubject(String[] subject)
                  throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core subject.

Specified by:

setDCSubject in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

subject - the Dublin Core subject to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCDescription

public void setDCDescription(String description)
                      throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core description.

Specified by:

setDCDescription in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

description - the Dublin Core description to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCPublisher

public void setDCPublisher(String publisher)
                    throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core publisher.

Specified by:

setDCPublisher in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

publisher - the Dublin Core publisher to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCContributor

public void setDCContributor(String contributor)
                      throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core contributor.

Specified by:

setDCContributor in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

contributor - the Dublin Core contributor to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCDate

public void setDCDate(Date date)
               throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core date.

Specified by:

setDCDate in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

date - the Dublin Core date to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCType

public void setDCType(String type)
               throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core type. You can use a constant from org.ametys.plugins.repository.dublincore.DCMITypes.

Specified by:

setDCType in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

type - the Dublin Core type to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCFormat

public void setDCFormat(String format)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core format.

Specified by:

setDCFormat in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

format - the Dublin Core format to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCIdentifier

public void setDCIdentifier(String identifier)
                     throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core identifier.

Specified by:

setDCIdentifier in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

identifier - the Dublin Core identifier to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCSource

public void setDCSource(String source)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core source.

Specified by:

setDCSource in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

source - the Dublin Core source to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCLanguage

public void setDCLanguage(String language)
                   throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core language.

Specified by:

setDCLanguage in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

language - the Dublin Core language to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCRelation

public void setDCRelation(String relation)
                   throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core relation.

Specified by:

setDCRelation in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

relation - the Dublin Core relation to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCCoverage

public void setDCCoverage(String coverage)
                   throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core coverage.

Specified by:

setDCCoverage in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

coverage - the Dublin Core coverage to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

setDCRights

public void setDCRights(String rights)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableDublinCoreAwareAmetysObject

Set the Dublin Core rights.

Specified by:

setDCRights in interface ModifiableDublinCoreAwareAmetysObject

Parameters:

rights - the Dublin Core rights to set. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

createComment

public Comment createComment()

Description copied from interface: CommentableAmetysObject

Creates a comment

Specified by:

createComment in interface CommentableAmetysObject<F extends ModifiableContentFactory>

Returns:

The new comment

createComment

public Comment createComment(String commentId,
 ZonedDateTime creationDate)

Description copied from interface: CommentableAmetysObject

Creates a comment with the given id and creation date This method allow to create a comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted. Be careful using this method

Specified by:

createComment in interface CommentableAmetysObject<F extends ModifiableContentFactory>

Parameters:

commentId - the comment's id

creationDate - the comment's creation date

Returns:

the new comment

getComment

public Comment getComment(String commentId)
                   throws AmetysRepositoryException

Description copied from interface: CommentableAmetysObject

Get a comment

Specified by:

getComment in interface CommentableAmetysObject<F extends ModifiableContentFactory>

Parameters:

commentId - The comment

Returns:

The comment

Throws:

AmetysRepositoryException - if error occurs

getComments

public List<Comment> getComments(boolean includeNotValidatedComments,
 boolean includeValidatedComments)
                          throws AmetysRepositoryException

Description copied from interface: CommentableAmetysObject

Get the list of available comments (validated, not validated, both or none :))

Specified by:

getComments in interface CommentableAmetysObject<F extends ModifiableContentFactory>

Parameters:

includeNotValidatedComments - true to get the non validated comments.

includeValidatedComments - true to get the validated comment.

Returns:

A non null list of comments on the ametys object.

Throws:

AmetysRepositoryException - if an error occurred

createContributorComment

public Comment createContributorComment()

Description copied from interface: ContributorCommentableAmetysObject

Creates a contributor comment

Specified by:

createContributorComment in interface ContributorCommentableAmetysObject

Returns:

The new comment

createContributorComment

public Comment createContributorComment(String commentId,
 ZonedDateTime creationDate)

Description copied from interface: ContributorCommentableAmetysObject

Creates a contributor comment with the given id and creation date This method allow to create a contributor comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted. Be careful using this method

Specified by:

createContributorComment in interface ContributorCommentableAmetysObject

Parameters:

commentId - the comment's id

creationDate - the comment's creation date

Returns:

the new comment

getContributorComment

public Comment getContributorComment(String commentId)
                              throws AmetysRepositoryException

Description copied from interface: ContributorCommentableAmetysObject

Get a contributor comment

Specified by:

getContributorComment in interface ContributorCommentableAmetysObject

Parameters:

commentId - The comment

Returns:

The contributor comment

Throws:

AmetysRepositoryException - if error occurs

getContributorComments

public List<Comment> getContributorComments()
                                     throws AmetysRepositoryException

Description copied from interface: ContributorCommentableAmetysObject

Get the list of available contributor comments

Specified by:

getContributorComments in interface ContributorCommentableAmetysObject

Returns:

A non null list of contributor comments on the ametys object.

Throws:

AmetysRepositoryException - if an error occurred

getDataHolder

public ModifiableContentDataHolder 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

Overrides:

getDataHolder in class DefaultContent<F extends ModifiableContentFactory>

Returns:

the DataHolder of this AmetysObject

fillContent

public void fillContent(Node node,
 XMLValuesExtractorAdditionalDataGetter additionalDataGetter)
                 throws Exception

Description copied from interface: ModifiableContent

Fills the current content with the values from the provided Node.
This is the anti-operation of Content.toSAX(org.xml.sax.ContentHandler, java.util.Locale, org.ametys.runtime.model.View, boolean), as the Node should be a Node previously generated with SAX events from this method.

Specified by:

fillContent in interface ModifiableContent

Parameters:

node - The node to read for retrieving values to fill

additionalDataGetter - The object that will retrieve potential additional data for the content's attributes

Throws:

Exception - if an exception occurs