Package org.ametys.cms.repository.comment

Interface CommentableContent

All Superinterfaces:

ACLAmetysObject, AmetysObject, Content, DataAwareAmetysObject, DataHolder, DublinCoreAwareAmetysObject, MetadataAwareAmetysObject, ModelAwareDataAwareAmetysObject, ModelAwareDataHolder, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableContent, ModifiableDataHolder, ModifiableDublinCoreAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, ModifiableModelAwareDataHolder, RemovableAmetysObject, TagAwareAmetysObject, TaggableAmetysObject

All Known Implementing Classes:

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

public interface CommentableContent
extends ModifiableContent

A content that can be commented by the users

Field Summary

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

ATTRIBUTE_TITLE, METADATA_TITLE

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

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

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	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 :))

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, getLanguage, getLastContributor, getLastMajorValidationDate, getLastModified, getLastValidationDate, getMixinTypes, getOutgoingReferences, getReferencingContents, getRootAttachments, getTitle, getTitle, getTypes, hasReferencingContents, toSAX

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

copyTo, 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.data.ametysobject.ModelAwareDataAwareAmetysObject

getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasLocalValue, hasNonEmptyExternalValue, hasNonEmptyLocalValue, hasNonEmptyValue, hasValue

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

commentsToSAX, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getType, getValue, hasNonEmptyValue, hasValue, 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.cms.repository.ModifiableContent

fillContent, setCreationDate, setCreator, setFirstValidationDate, setLanguage, setLastContributor, setLastMajorValidationDate, setLastModified, setLastValidationDate, setMixinTypes, setOutgoingReferences, setTitle, setTitle, setTypes

Methods inherited from interface org.ametys.plugins.repository.dublincore.ModifiableDublinCoreAwareAmetysObject

setDCContributor, setDCCoverage, setDCCreator, setDCDate, setDCDescription, setDCFormat, setDCIdentifier, setDCLanguage, setDCPublisher, setDCRelation, setDCRights, setDCSource, setDCSubject, setDCTitle, setDCType

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

getMetadataHolder

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

getComposite, getComposite, getDataHolder, getExternalComposite, getExternalComposite, getExternalRepeater, getExternalRepeater, getLocalComposite, getLocalComposite, getLocalRepeater, getLocalRepeater, getParentDataHolder, getRepeater, getRepeater, getRepositoryData, getRootDataHolder, 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.cms.repository.TagAwareAmetysObject

getTags

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

tag, untag

Method Detail

createComment

Comment createComment()

Creates a comment

Returns:

The new comment

createComment

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. Be careful using this method

Parameters:

commentId - the comment's id

creationDate - the comment's creation date

Returns:

the new comment

getComment

Comment getComment(String commentId)
            throws AmetysRepositoryException

Get a comment

Parameters:

commentId - The comment

Returns:

The comment

Throws:

AmetysRepositoryException - if the comment does not exist

getComments

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

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

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

Throws:

AmetysRepositoryException - if an error occurred