Package org.ametys.plugins.workspaces.tasks.jcr

Class JCRTask

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

org.ametys.plugins.workspaces.tasks.jcr.JCRTask

All Implemented Interfaces:

CommentableAmetysObject, ACLAmetysObject, AmetysObject, DataAwareAmetysObject, ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, RemovableAmetysObject, TagAwareAmetysObject, TaggableAmetysObject, DataAndVersionAwareAmetysObject, ModifiableDataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject, Task

public class JCRTask
extends DefaultAmetysObject<JCRTaskFactory>
implements Task

JCR implementation of a task

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.plugins.workspaces.tasks.Task

Task.CheckItem

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTRIBUTE_ASSIGNMENTS	Attribute Assignments
static String	ATTRIBUTE_ATTACHMENTS	Attribute Attachments
static String	ATTRIBUTE_AUTHOR	Attribute Author
static String	ATTRIBUTE_CHECKLIST	Attribute CheckList
static String	ATTRIBUTE_CHECKLIST_ISCHECKED	Attribute IsChecked for checkList
static String	ATTRIBUTE_CHECKLIST_LABEL	Attribute Label for checkList
static String	ATTRIBUTE_CLOSEAUTHOR	Attribute CloseAuthor
static String	ATTRIBUTE_CLOSEDATE	Attribute CloseDate
static String	ATTRIBUTE_CREATIONDATE	Attribute Creationdate
static String	ATTRIBUTE_DESCRIPTION	Attribute Description
static String	ATTRIBUTE_DUEDATE	Attribute DueDate
static String	ATTRIBUTE_ISCLOSED	Attribute IsClosed
static String	ATTRIBUTE_LABEL	Attribute Label
static String	ATTRIBUTE_LASTMODIFIED	Attribute Lastmodified
static String	ATTRIBUTE_STARTDATE	Attribute Startdate
static String	ATTRIBUTE_TASK_ID	Attribute Taskid
static String	ATTRIBUTE_TASKSLISTID	Attribute Taskid
static String	ATTRIBUTE_TASKSLISTPOSITION	Attribute Taskid

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

PROTECTED_PROPERTIES

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

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
JCRTask(Node node, String parentPath, JCRTaskFactory factory)	Default constructor for the JCRTask

Method Summary

Modifier and Type	Method	Description
void	close(boolean isClosed)	Close the task
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.
List<UserIdentity>	getAssignments()	Get the list of user assigned to this task
List<Binary>	getAttachments()	Get the task's attachments list
UserIdentity	getAuthor()	Get the author of the task
List<Task.CheckItem>	getCheckList()	Get the task's check list
UserIdentity	getCloseAuthor()	Get the author who close the task
LocalDate	getCloseDate()	Get the task's date of closure
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 :))
ZonedDateTime	getCreationDate()	Get the task's creation date.
ModifiableModelAwareDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
String	getDescription()	The description of the task
LocalDate	getDueDate()	The due date of the task
String	getLabel()	The title of the task
ZonedDateTime	getLastModified()	Get the task's last modification date.
Long	getPosition()	The position into the task list
LocalDate	getStartDate()	The starting date of the task
Set<String>	getTags()	Retrieves current tags.
String	getTaskListId()	The identifier of a task list
boolean	isClosed()	True if the task is closed
void	setAssignments(List<UserIdentity> assignments)	Set the list of user assigned to this task
void	setAttachments(List<Binary> attachments)	Set the task's attachments list
void	setAuthor(UserIdentity author)	Set the author of this task.
void	setCheckListItem(List<Task.CheckItem> checkItems)	Set the list of check item
void	setCloseAuthor(UserIdentity author)	Set the author who close the task.
void	setCloseDate(LocalDate closedDate)	Set the task's date of closure
void	setCreationDate(ZonedDateTime creationDate)	Set the post's creation date.
void	setDescription(String description)	Set the description of the task
void	setDueDate(LocalDate dueDate)	Set the due date of the task
void	setLabel(String label)	Set the label of the task
void	setLastModified(ZonedDateTime lastModifiedDate)	Set the post's modification date.
void	setPosition(Long position)	Set the position into the task list
void	setStartDate(LocalDate startDate)	Set the starting date of the task
void	setTasksListId(String taskListId)	Set the identifier of a tasks list
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, dataToSAX, dataToSAX

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

getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty

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

commentsToSAX, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, 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.ametysobject.ModifiableModelAwareDataAwareAmetysObject

getComposite, getComposite, getExternalComposite, getExternalComposite, getExternalRepeater, getExternalRepeater, getLocalComposite, getLocalComposite, getLocalRepeater, getLocalRepeater, getParentDataHolder, getRepeater, getRepeater, getRepositoryData, getRootDataHolder, removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, removeValue, setComments, setExternalValue, setLocalValue, setStatus, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues

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

remove

Field Detail

ATTRIBUTE_TASK_ID

public static final String ATTRIBUTE_TASK_ID

Attribute Taskid

See Also:

Constant Field Values

ATTRIBUTE_TASKSLISTID

public static final String ATTRIBUTE_TASKSLISTID

Attribute Taskid

See Also:

Constant Field Values

ATTRIBUTE_TASKSLISTPOSITION

public static final String ATTRIBUTE_TASKSLISTPOSITION

Attribute Taskid

See Also:

Constant Field Values

ATTRIBUTE_LABEL

public static final String ATTRIBUTE_LABEL

Attribute Label

See Also:

Constant Field Values

ATTRIBUTE_DESCRIPTION

public static final String ATTRIBUTE_DESCRIPTION

Attribute Description

See Also:

Constant Field Values

ATTRIBUTE_STARTDATE

public static final String ATTRIBUTE_STARTDATE

Attribute Startdate

See Also:

Constant Field Values

ATTRIBUTE_DUEDATE

public static final String ATTRIBUTE_DUEDATE

Attribute DueDate

See Also:

Constant Field Values

ATTRIBUTE_ISCLOSED

public static final String ATTRIBUTE_ISCLOSED

Attribute IsClosed

See Also:

Constant Field Values

ATTRIBUTE_CLOSEDATE

public static final String ATTRIBUTE_CLOSEDATE

Attribute CloseDate

See Also:

Constant Field Values

ATTRIBUTE_CLOSEAUTHOR

public static final String ATTRIBUTE_CLOSEAUTHOR

Attribute CloseAuthor

See Also:

Constant Field Values

ATTRIBUTE_AUTHOR

public static final String ATTRIBUTE_AUTHOR

Attribute Author

See Also:

Constant Field Values

ATTRIBUTE_ASSIGNMENTS

public static final String ATTRIBUTE_ASSIGNMENTS

Attribute Assignments

See Also:

Constant Field Values

ATTRIBUTE_CREATIONDATE

public static final String ATTRIBUTE_CREATIONDATE

Attribute Creationdate

See Also:

Constant Field Values

ATTRIBUTE_LASTMODIFIED

public static final String ATTRIBUTE_LASTMODIFIED

Attribute Lastmodified

See Also:

Constant Field Values

ATTRIBUTE_ATTACHMENTS

public static final String ATTRIBUTE_ATTACHMENTS

Attribute Attachments

See Also:

Constant Field Values

ATTRIBUTE_CHECKLIST

public static final String ATTRIBUTE_CHECKLIST

Attribute CheckList

See Also:

Constant Field Values

ATTRIBUTE_CHECKLIST_LABEL

public static final String ATTRIBUTE_CHECKLIST_LABEL

Attribute Label for checkList

See Also:

Constant Field Values

ATTRIBUTE_CHECKLIST_ISCHECKED

public static final String ATTRIBUTE_CHECKLIST_ISCHECKED

Attribute IsChecked for checkList

See Also:

Constant Field Values

Constructor Detail

JCRTask

public JCRTask(Node node,
               String parentPath,
               JCRTaskFactory factory)

Default constructor for the JCRTask

Parameters:

node - The task node

parentPath - The parent path

factory - The factory

Method Detail

getTaskListId

public String getTaskListId()

Description copied from interface: Task

The identifier of a task list

Specified by:

getTaskListId in interface Task

Returns:

The id

setTasksListId

public void setTasksListId(String taskListId)

Description copied from interface: Task

Set the identifier of a tasks list

Specified by:

setTasksListId in interface Task

Parameters:

taskListId - The tasks list id

getPosition

public Long getPosition()

Description copied from interface: Task

The position into the task list

Specified by:

getPosition in interface Task

Returns:

The position

setPosition

public void setPosition(Long position)

Description copied from interface: Task

Set the position into the task list

Specified by:

setPosition in interface Task

Parameters:

position - The position into the task list

getLabel

public String getLabel()

Description copied from interface: Task

The title of the task

Specified by:

getLabel in interface Task

Returns:

The title

setLabel

public void setLabel(String label)

Description copied from interface: Task

Set the label of the task

Specified by:

setLabel in interface Task

Parameters:

label - The label

getDescription

public String getDescription()

Description copied from interface: Task

The description of the task

Specified by:

getDescription in interface Task

Returns:

The description

setDescription

public void setDescription(String description)

Description copied from interface: Task

Set the description of the task

Specified by:

setDescription in interface Task

Parameters:

description - The description

getStartDate

public LocalDate getStartDate()

Description copied from interface: Task

The starting date of the task

Specified by:

getStartDate in interface Task

Returns:

The start date

setStartDate

public void setStartDate(LocalDate startDate)

Description copied from interface: Task

Set the starting date of the task

Specified by:

setStartDate in interface Task

Parameters:

startDate - The start date

getDueDate

public LocalDate getDueDate()

Description copied from interface: Task

The due date of the task

Specified by:

getDueDate in interface Task

Returns:

The due date

setDueDate

public void setDueDate(LocalDate dueDate)

Description copied from interface: Task

Set the due date of the task

Specified by:

setDueDate in interface Task

Parameters:

dueDate - The due date

isClosed

public boolean isClosed()

Description copied from interface: Task

True if the task is closed

Specified by:

isClosed in interface Task

Returns:

true if the task is closed

close

public void close(boolean isClosed)

Description copied from interface: Task

Close the task

Specified by:

close in interface Task

Parameters:

isClosed - true to close the task

getCloseAuthor

public UserIdentity getCloseAuthor()

Description copied from interface: Task

Get the author who close the task

Specified by:

getCloseAuthor in interface Task

Returns:

the author who close the task

setCloseAuthor

public void setCloseAuthor(UserIdentity author)

Description copied from interface: Task

Set the author who close the task.

Specified by:

setCloseAuthor in interface Task

Parameters:

author - the author

getCloseDate

public LocalDate getCloseDate()

Description copied from interface: Task

Get the task's date of closure

Specified by:

getCloseDate in interface Task

Returns:

the task's date of closure

setCloseDate

public void setCloseDate(LocalDate closedDate)

Description copied from interface: Task

Set the task's date of closure

Specified by:

setCloseDate in interface Task

Parameters:

closedDate - The date of closure

getAuthor

public UserIdentity getAuthor()

Description copied from interface: Task

Get the author of the task

Specified by:

getAuthor in interface Task

Returns:

the author

setAuthor

public void setAuthor(UserIdentity author)

Description copied from interface: Task

Set the author of this task.

Specified by:

setAuthor in interface Task

Parameters:

author - the author

getAssignments

public List<UserIdentity> getAssignments()

Description copied from interface: Task

Get the list of user assigned to this task

Specified by:

getAssignments in interface Task

Returns:

The assignment list

setAssignments

public void setAssignments(List<UserIdentity> assignments)

Description copied from interface: Task

Set the list of user assigned to this task

Specified by:

setAssignments in interface Task

Parameters:

assignments - The assignment list

getCreationDate

public ZonedDateTime getCreationDate()

Description copied from interface: Task

Get the task's creation date.

Specified by:

getCreationDate in interface Task

Returns:

the task's creation date.

setCreationDate

public void setCreationDate(ZonedDateTime creationDate)

Description copied from interface: Task

Set the post's creation date.

Specified by:

setCreationDate in interface Task

Parameters:

creationDate - the post's creation date.

getLastModified

public ZonedDateTime getLastModified()

Description copied from interface: Task

Get the task's last modification date.

Specified by:

getLastModified in interface Task

Returns:

the task's last modification date.

setLastModified

public void setLastModified(ZonedDateTime lastModifiedDate)

Description copied from interface: Task

Set the post's modification date.

Specified by:

setLastModified in interface Task

Parameters:

lastModifiedDate - the last modification date to set.

getAttachments

public List<Binary> getAttachments()

Description copied from interface: Task

Get the task's attachments list

Specified by:

getAttachments in interface Task

Returns:

the task's attachments list

setAttachments

public void setAttachments(List<Binary> attachments)

Description copied from interface: Task

Set the task's attachments list

Specified by:

setAttachments in interface Task

Parameters:

attachments - the task's attachments list

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.

getCheckList

public List<Task.CheckItem> getCheckList()

Description copied from interface: Task

Get the task's check list

Specified by:

getCheckList in interface Task

Returns:

the task's check list

setCheckListItem

public void setCheckListItem(List<Task.CheckItem> checkItems)

Description copied from interface: Task

Set the list of check item

Specified by:

setCheckListItem in interface Task

Parameters:

checkItems - the list of check item

createComment

public Comment createComment()

Description copied from interface: CommentableAmetysObject

Creates a comment

Specified by:

createComment in interface CommentableAmetysObject

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

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

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

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

getDataHolder

public ModifiableModelAwareDataHolder 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 ModifiableModelAwareDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject