Package org.ametys.plugins.workspaces.forum

Interface Thread

All Superinterfaces:

AmetysObject, AttachableAmetysObject, CommentableAmetysObject<RichTextComment>, DataAwareAmetysObject, DataHolder, IndexableDataHolder, ModelAwareDataAwareAmetysObject, ModelAwareDataAwareAmetysObject, ModelAwareDataHolder, ModifiableAmetysObject, ModifiableDataHolder, ModifiableIndexableDataHolder, ModifiableModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, ModifiableModelAwareDataHolder, RemovableAmetysObject, TagAwareAmetysObject, TaggableAmetysObject

All Known Implementing Classes:

JCRThread

public interface Thread
extends ModifiableModelAwareDataAwareAmetysObject, RemovableAmetysObject, TaggableAmetysObject, AttachableAmetysObject, CommentableAmetysObject<RichTextComment>

Interface representing a forum's thread

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPTED_ANSWER_COMMENT_ID	Computed acceptedAnswer attribute
static final String	ATTRIBUTE_ATTACHMENTS	Attribute Attachments
static final String	ATTRIBUTE_AUTHOR	Attribute Author
static final String	ATTRIBUTE_CATEGORY	Attribute Category
static final String	ATTRIBUTE_CLOSEAUTHOR	Attribute Category
static final String	ATTRIBUTE_CLOSEDATE	Attribute Category
static final String	ATTRIBUTE_COMMENTS	Attribute Comments
static final String	ATTRIBUTE_COMMENTS_AUTHORS	Attribute CommentAuthors, used to get number of comments without parsing them
static final String	ATTRIBUTE_COMMENTS_LENTGH	Attribute CommentsLength, used to get number of comments without parsing them
static final String	ATTRIBUTE_CONTENT	Attribute Description
static final String	ATTRIBUTE_CONTENT_ABSTRACT	Attribute Description abstract
static final String	ATTRIBUTE_CONTENT_FOR_EDITING	Attribute Description for editing
static final String	ATTRIBUTE_CONTENT_FOR_RENDERING	Attribute Description for editing
static final String	ATTRIBUTE_CREATIONDATE	Attribute Creationdate
static final String	ATTRIBUTE_ID	Attribute Threadid
static final String	ATTRIBUTE_LASTCONTRIBUTION	Attribute LastContribution : set on creation, updated for each anwer added
static final String	ATTRIBUTE_LASTMODIFIED	Attribute Lastmodified
static final String	ATTRIBUTE_TAGS	Attribute Tags
static final String	ATTRIBUTE_TITLE	Attribute Label
static final String	HAS_UNOPENED_THREAD_NOTIFICATION	Computed hasNotificationDot attribute
static final String	IS_AUTHOR	Computed isAuthor attribute
static final String	UNREAD_COMMENTS	Computed unreadComments attribute

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

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Method Summary

Modifier and Type	Method	Description
RichTextComment	getAcceptedAnswer()	Get the accepted answer.
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.
RichText	getContent()	The content of the thread
ZonedDateTime	getCreationDate()	Get the thread's creation date.
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.
String	getTitle()	The title of the thread
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 content)	Set the content of the thread
void	setCreationDate(ZonedDateTime startDate)	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

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

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

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

getAttachments, setAttachments

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

createComment, createComment, getComment, getComments

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, 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.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, getDataHolder, 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.tag.TaggableAmetysObject

tag, untag

Field Details

ATTRIBUTE_ID

static final String ATTRIBUTE_ID

Attribute Threadid

See Also:

• Constant Field Values

ATTRIBUTE_TITLE

static final String ATTRIBUTE_TITLE

Attribute Label

See Also:

• Constant Field Values

ATTRIBUTE_CONTENT

static final String ATTRIBUTE_CONTENT

Attribute Description

See Also:

• Constant Field Values

ATTRIBUTE_CONTENT_FOR_EDITING

static final String ATTRIBUTE_CONTENT_FOR_EDITING

Attribute Description for editing

See Also:

• Constant Field Values

ATTRIBUTE_CONTENT_FOR_RENDERING

static final String ATTRIBUTE_CONTENT_FOR_RENDERING

Attribute Description for editing

See Also:

• Constant Field Values

ATTRIBUTE_CONTENT_ABSTRACT

static final String ATTRIBUTE_CONTENT_ABSTRACT

Attribute Description abstract

See Also:

• Constant Field Values

ATTRIBUTE_AUTHOR

static final String ATTRIBUTE_AUTHOR

Attribute Author

See Also:

• Constant Field Values

ATTRIBUTE_CREATIONDATE

static final String ATTRIBUTE_CREATIONDATE

Attribute Creationdate

See Also:

• Constant Field Values

ATTRIBUTE_LASTMODIFIED

static final String ATTRIBUTE_LASTMODIFIED

Attribute Lastmodified

See Also:

• Constant Field Values

ATTRIBUTE_LASTCONTRIBUTION

static final String ATTRIBUTE_LASTCONTRIBUTION

Attribute LastContribution : set on creation, updated for each anwer added

See Also:

• Constant Field Values

ATTRIBUTE_CATEGORY

static final String ATTRIBUTE_CATEGORY

Attribute Category

See Also:

• Constant Field Values

ATTRIBUTE_CLOSEAUTHOR

static final String ATTRIBUTE_CLOSEAUTHOR

Attribute Category

See Also:

• Constant Field Values

ATTRIBUTE_CLOSEDATE

static final String ATTRIBUTE_CLOSEDATE

Attribute Category

See Also:

• Constant Field Values

ATTRIBUTE_ATTACHMENTS

static final String ATTRIBUTE_ATTACHMENTS

Attribute Attachments

See Also:

• Constant Field Values

ATTRIBUTE_TAGS

static final String ATTRIBUTE_TAGS

Attribute Tags

See Also:

• Constant Field Values

ATTRIBUTE_COMMENTS

static final String ATTRIBUTE_COMMENTS

Attribute Comments

See Also:

• Constant Field Values

ATTRIBUTE_COMMENTS_LENTGH

static final String ATTRIBUTE_COMMENTS_LENTGH

Attribute CommentsLength, used to get number of comments without parsing them

See Also:

• Constant Field Values

ATTRIBUTE_COMMENTS_AUTHORS

static final String ATTRIBUTE_COMMENTS_AUTHORS

Attribute CommentAuthors, used to get number of comments without parsing them

See Also:

• Constant Field Values

HAS_UNOPENED_THREAD_NOTIFICATION

static final String HAS_UNOPENED_THREAD_NOTIFICATION

Computed hasNotificationDot attribute

See Also:

• Constant Field Values

ACCEPTED_ANSWER_COMMENT_ID

static final String ACCEPTED_ANSWER_COMMENT_ID

Computed acceptedAnswer attribute

See Also:

• Constant Field Values

UNREAD_COMMENTS

static final String UNREAD_COMMENTS

Computed unreadComments attribute

See Also:

• Constant Field Values

IS_AUTHOR

static final String IS_AUTHOR

Computed isAuthor attribute

See Also:

• Constant Field Values

Method Details

getTitle

String getTitle()

The title of the thread

Returns:

The title

setTitle

void setTitle(String title)

Set the title of the thread

Parameters:

title - The title

getContent

RichText getContent()

The content of the thread

Returns:

The content

setContent

void setContent(RichText content)

Set the content of the thread

Parameters:

content - The content

getAuthor

UserIdentity getAuthor()

Get the author of the thread

Returns:

the author

setAuthor

void setAuthor(UserIdentity author)

Set the author of this thread.

Parameters:

author - the author

getCreationDate

ZonedDateTime getCreationDate()

Get the thread's creation date.

Returns:

the thread's creation date.

setCreationDate

void setCreationDate(ZonedDateTime startDate)

Set the thread's creation date.

Parameters:

startDate - the task's creation date.

getLastModified

ZonedDateTime getLastModified()

Get the thread's last modification date.

Returns:

the thread's last modification date.

setLastModified

void setLastModified(ZonedDateTime date)

Set the thread's modification date.

Parameters:

date - the last modification date to set.

getLastContribution

ZonedDateTime getLastContribution()

Get the thread's last contribution date.

Returns:

the thread's last contribution date.

setLastContribution

void setLastContribution(ZonedDateTime date)

Set the thread's contribution date.

Parameters:

date - the last contribution date to set.

getCategory

ThreadCategoryEnum getCategory()

The category of the thread

Returns:

The category

setCategory

void setCategory(ThreadCategoryEnum category)

Set the category of the thread

Parameters:

category - The category

getCloseAuthor

UserIdentity getCloseAuthor()

Get the close author of the thread

Returns:

the close author

setCloseAuthor

void setCloseAuthor(UserIdentity author)

Set the close author of this thread.

Parameters:

author - the close author

getCloseDate

ZonedDateTime getCloseDate()

Get the thread's close date.

Returns:

the thread's close date.

setCloseDate

void setCloseDate(ZonedDateTime date)

Set the thread's close date.

Parameters:

date - the close date to set.

getAcceptedAnswer

RichTextComment getAcceptedAnswer()

Get the accepted answer.

Returns:

the accepted answer if present, null otherwise.

getFlattenComments

List<RichTextComment> getFlattenComments(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 ametys object.

Throws:

AmetysRepositoryException - if an error occurred