org.ametys.cms.repository.comment

Interface CommentableContent

All Superinterfaces:

ACLAmetysObject, AmetysObject, Content, DublinCoreAwareAmetysObject, MetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableContent, ModifiableDublinCoreAwareAmetysObject, ModifiableMetadataAwareAmetysObject, RemovableAmetysObject, TagAwareAmetysObject, TaggableAmetysObject

All Known Implementing Classes:

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

public interface CommentableContent
extends ModifiableContent

A content that can be commented by the users

Method Summary

Modifier and Type	Method and Description
Comment	createComment() Creates a comment
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.cms.repository.ModifiableContent

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

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

getCreationDate, getCreator, getLanguage, getLastContributor, getLastMajorValidationDate, getLastModified, getLastValidationDate, getMixinTypes, getOutgoingReferences, getReferencingContents, getRootAttachments, getTitle, getTitle, getTypes, hasReferencingContents

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

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

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

getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers

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

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

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

getMetadataHolder

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

needsSave, rename, revertChanges, saveChanges

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

remove

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

tag, untag

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

getTags

Method Detail

createComment

Comment createComment()

Creates a comment

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 occured