Package org.ametys.plugins.workspaces.forum.jcr

Class JCRThread

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

org.ametys.plugins.workspaces.forum.jcr.JCRThread

All Implemented Interfaces:

ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, IndexableDataHolder, ModifiableIndexableDataHolder, AttachableAmetysObject, CommentableAmetysObject<RichTextComment>, ACLAmetysObject, AmetysObject, DataAwareAmetysObject, ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, RemovableAmetysObject, TagAwareAmetysObject, TaggableAmetysObject, DataAndVersionAwareAmetysObject, ModifiableDataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject, Thread

public class JCRThread
extends DefaultAmetysObject<JCRThreadFactory>
implements Thread

JCR implementation of a Thread

Field Summary

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

__VERSION_COMPARATOR, PROTECTED_PROPERTIES

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

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Fields inherited from interface org.ametys.plugins.workspaces.forum.Thread

ACCEPTED_ANSWER_COMMENT_ID, ATTRIBUTE_ATTACHMENTS, ATTRIBUTE_AUTHOR, ATTRIBUTE_CATEGORY, ATTRIBUTE_CLOSEAUTHOR, ATTRIBUTE_CLOSEDATE, ATTRIBUTE_COMMENTS, ATTRIBUTE_COMMENTS_AUTHORS, ATTRIBUTE_COMMENTS_LENTGH, ATTRIBUTE_CONTENT, ATTRIBUTE_CONTENT_ABSTRACT, ATTRIBUTE_CONTENT_FOR_EDITING, ATTRIBUTE_CONTENT_FOR_RENDERING, ATTRIBUTE_CREATIONDATE, ATTRIBUTE_ID, ATTRIBUTE_LASTCONTRIBUTION, ATTRIBUTE_LASTMODIFIED, ATTRIBUTE_TAGS, ATTRIBUTE_TITLE, HAS_UNOPENED_THREAD_NOTIFICATION, IS_AUTHOR, UNREAD_COMMENTS

Constructor Summary

Constructors

Constructor	Description
JCRThread(javax.jcr.Node node, String parentPath, JCRThreadFactory factory)	Default constructor for the JCRThread

Method Summary

Modifier and Type	Method	Description
RichTextComment	createComment()	Creates a comment
RichTextComment	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.
RichTextComment	getAcceptedAnswer()	Get the accepted answer.
List<Binary>	getAttachments()	Get the attachments list
UserIdentity	getAuthor()	Get the author of the thread
ThreadCategoryEnum	getCategory()	The category of the thread
UserIdentity	getCloseAuthor()	Get the close author of the thread
ZonedDateTime	getCloseDate()	Get the thread's close date.
RichTextComment	getComment(String commentId)	Get a comment
List<RichTextComment>	getComments(boolean includeNotValidatedComments, boolean includeValidatedComments)	Get the list of available comments (validated, not validated, both or none :))
RichText	getContent()	The content of the thread
ZonedDateTime	getCreationDate()	Get the thread's creation date.
ModifiableIndexableDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
List<RichTextComment>	getFlattenComments(boolean includeNotValidatedComments, boolean includeValidatedComments)	Get the list of available comments (validated, not validated, both or none :))
ZonedDateTime	getLastContribution()	Get the thread's last contribution date.
ZonedDateTime	getLastModified()	Get the thread's last modification date.
Set<String>	getTags()	Retrieves current tags.
String	getTitle()	The title of the thread
void	setAttachments(List<Binary> attachments)	Set the attachments list
void	setAuthor(UserIdentity author)	Set the author of this thread.
void	setCategory(ThreadCategoryEnum category)	Set the category of the thread
void	setCloseAuthor(UserIdentity author)	Set the close author of this thread.
void	setCloseDate(ZonedDateTime date)	Set the thread's close date.
void	setContent(RichText richText)	Set the content of the thread
void	setCreationDate(ZonedDateTime creationDate)	Set the thread's creation date.
void	setLastContribution(ZonedDateTime date)	Set the thread's contribution date.
void	setLastModified(ZonedDateTime date)	Set the thread's modification date.
void	setTitle(String title)	Set the title of the thread
void	tag(String tag)	Tags.
void	untag(String tag)	Untags.

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

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

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX

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

getSystemPropertyExtensionPoint, indexData, indexData

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

dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAXForEdition, getDataNames, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty

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

dataToJSON, dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, getDataNames, getType, getValue, hasValue, hasValueOrEmpty, isMultiple

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.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, setExternalValue, setLocalValue, setStatus, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues

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

remove

Constructor Details

JCRThread

public JCRThread(javax.jcr.Node node,
 String parentPath,
 JCRThreadFactory factory)

Default constructor for the JCRThread

Parameters:

node - The thread node

parentPath - The parent path

factory - The factory

Method Details

getTitle

public String getTitle()

Description copied from interface: Thread

The title of the thread

Specified by:

getTitle in interface Thread

Returns:

The title

setTitle

public void setTitle(String title)

Description copied from interface: Thread

Set the title of the thread

Specified by:

setTitle in interface Thread

Parameters:

title - The title

getContent

public RichText getContent()

Description copied from interface: Thread

The content of the thread

Specified by:

getContent in interface Thread

Returns:

The content

setContent

public void setContent(RichText richText)

Description copied from interface: Thread

Set the content of the thread

Specified by:

setContent in interface Thread

Parameters:

richText - The content

getAuthor

public UserIdentity getAuthor()

Description copied from interface: Thread

Get the author of the thread

Specified by:

getAuthor in interface Thread

Returns:

the author

setAuthor

public void setAuthor(UserIdentity author)

Description copied from interface: Thread

Set the author of this thread.

Specified by:

setAuthor in interface Thread

Parameters:

author - the author

getCreationDate

public ZonedDateTime getCreationDate()

Description copied from interface: Thread

Get the thread's creation date.

Specified by:

getCreationDate in interface Thread

Returns:

the thread's creation date.

setCreationDate

public void setCreationDate(ZonedDateTime creationDate)

Description copied from interface: Thread

Set the thread's creation date.

Specified by:

setCreationDate in interface Thread

Parameters:

creationDate - the task's creation date.

getLastModified

public ZonedDateTime getLastModified()

Description copied from interface: Thread

Get the thread's last modification date.

Specified by:

getLastModified in interface Thread

Returns:

the thread's last modification date.

setLastModified

public void setLastModified(ZonedDateTime date)

Description copied from interface: Thread

Set the thread's modification date.

Specified by:

setLastModified in interface Thread

Parameters:

date - the last modification date to set.

getLastContribution

public ZonedDateTime getLastContribution()

Description copied from interface: Thread

Get the thread's last contribution date.

Specified by:

getLastContribution in interface Thread

Returns:

the thread's last contribution date.

setLastContribution

public void setLastContribution(ZonedDateTime date)

Description copied from interface: Thread

Set the thread's contribution date.

Specified by:

setLastContribution in interface Thread

Parameters:

date - the last contribution date to set.

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.

getTags

public Set<String> getTags()
                    throws AmetysRepositoryException

Description copied from interface: TagAwareAmetysObject

Retrieves current tags.

Specified by:

getTags in interface TagAwareAmetysObject

Returns:

the current tags.

Throws:

AmetysRepositoryException - if an error occurs.

getDataHolder

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

Returns:

the DataHolder of this AmetysObject

getCategory

public ThreadCategoryEnum getCategory()

Description copied from interface: Thread

The category of the thread

Specified by:

getCategory in interface Thread

Returns:

The category

setCategory

public void setCategory(ThreadCategoryEnum category)

Description copied from interface: Thread

Set the category of the thread

Specified by:

setCategory in interface Thread

Parameters:

category - The category

getCloseAuthor

public UserIdentity getCloseAuthor()

Description copied from interface: Thread

Get the close author of the thread

Specified by:

getCloseAuthor in interface Thread

Returns:

the close author

setCloseAuthor

public void setCloseAuthor(UserIdentity author)

Description copied from interface: Thread

Set the close author of this thread.

Specified by:

setCloseAuthor in interface Thread

Parameters:

author - the close author

getCloseDate

public ZonedDateTime getCloseDate()

Description copied from interface: Thread

Get the thread's close date.

Specified by:

getCloseDate in interface Thread

Returns:

the thread's close date.

setCloseDate

public void setCloseDate(ZonedDateTime date)

Description copied from interface: Thread

Set the thread's close date.

Specified by:

setCloseDate in interface Thread

Parameters:

date - the close date to set.

getAttachments

public List<Binary> getAttachments()

Description copied from interface: AttachableAmetysObject

Get the attachments list

Specified by:

getAttachments in interface AttachableAmetysObject

Returns:

the attachments list

setAttachments

public void setAttachments(List<Binary> attachments)

Description copied from interface: AttachableAmetysObject

Set the attachments list

Specified by:

setAttachments in interface AttachableAmetysObject

Parameters:

attachments - the attachments list

createComment

public RichTextComment createComment()

Description copied from interface: CommentableAmetysObject

Creates a comment

Specified by:

createComment in interface CommentableAmetysObject<RichTextComment>

Returns:

The new comment

createComment

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

Parameters:

commentId - the comment's id

creationDate - the comment's creation date

Returns:

the new comment

getComment

public RichTextComment getComment(String commentId)
                           throws AmetysRepositoryException

Description copied from interface: CommentableAmetysObject

Get a comment

Specified by:

getComment in interface CommentableAmetysObject<RichTextComment>

Parameters:

commentId - The comment

Returns:

The comment

Throws:

AmetysRepositoryException - if error occurs

getComments

public List<RichTextComment> 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<RichTextComment>

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

getAcceptedAnswer

public RichTextComment getAcceptedAnswer()

Description copied from interface: Thread

Get the accepted answer.

Specified by:

getAcceptedAnswer in interface Thread

Returns:

the accepted answer if present, null otherwise.

getFlattenComments

public List<RichTextComment> getFlattenComments(boolean includeNotValidatedComments,
 boolean includeValidatedComments)
                                         throws AmetysRepositoryException

Description copied from interface: Thread

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

Specified by:

getFlattenComments in interface Thread

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