com.adobe.granite.taskmanagement

Interface Task

All Superinterfaces:

InboxItem

@ProviderType
public interface Task
extends InboxItem

Task class describes a task instance.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.granite.workflow.exec.InboxItem

InboxItem.Priority

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TASK_TYPE Default task type.

Method Summary

Modifier and Type	Method and Description
java.util.List<TaskAction>	getActions() returns the list of action objects for this task.
java.lang.String	getCompletedBy() Gets the ID for the user who completed the task
java.lang.String	getContentPath() Returns a content path this task is associated with.
java.lang.String	getCreatedBy() Gets the ID for the user who created the task
java.lang.String	getCurrentAssignee() Gets the id of the owner of the task.
java.lang.String	getDescription() Gets the description of the task.
java.lang.String	getId() Gets the ID of the task.
java.lang.String	getInstructions() Gets the instructions for this task.
java.util.Date	getLastModified() Gets the time this task was last updated.
java.lang.String	getLastModifiedBy() Gets the ID for the user who last modified the task
java.lang.String	getName() Gets the name of the task.
java.lang.String	getParentId() Returns the ID of the parent task.
java.lang.Object	getProperty(java.lang.String aPropertyName) Gets a property with the given name.
java.util.Iterator<java.lang.String>	getPropertyNames() Gets an iterator of the property names for this task.
TaskAction	getSelectedAction() gets the selected action used to complete the task.
Status	getStatus() Gets the current status of the task.
java.util.List<Task>	getSubTasks() Returns the list of subtasks for this task
java.lang.String	getTaskTypeName() Gets the type of this task.
java.util.Date	getTimeEnded() Gets the time this task was last completed.
java.util.Date	getTimeStarted() Gets the time this task was created.
boolean	hasSubTasks() Returns whether or not there are sub-tasks under this task.
boolean	isSubTaskInfoLoaded() Indicates if this task object is fully populated with sub task information.
void	setActions(java.util.List<TaskAction> aListOfActions) sets the list of action objects for this task.
void	setContentPath(java.lang.String contentPath) Sets a content path that this task is associated with.
void	setCurrentAssignee(java.lang.String ownerId) Sets the id of the owner of the task.
void	setDescription(java.lang.String description) Sets the description of the task.
void	setDueTime(java.util.Date dueTime) Sets the due time of this task.
void	setInstructions(java.lang.String aInstructions) Sets the instructions for this task.
void	setName(java.lang.String name) Sets the name of the task.
void	setPriority(InboxItem.Priority priority) Sets the priority for this task.
void	setProgressBeginTime(java.util.Date progressBeginTime) Sets the progress begin time for this task.
void	setProperty(java.lang.String name, java.lang.Object value) Sets the property.

Methods inherited from interface com.adobe.granite.workflow.exec.InboxItem

getDueTime, getItemSubType, getItemType, getPriority, getProgressBeginTime

Field Detail

DEFAULT_TASK_TYPE

static final java.lang.String DEFAULT_TASK_TYPE

Default task type.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Gets the ID of the task.

Specified by:

getId in interface InboxItem

Returns:

String containing the id of the task.

getParentId

java.lang.String getParentId()

Returns the ID of the parent task.

Returns:

the ID of the parent task, or null if this is not a sub-task.

getName

java.lang.String getName()

Gets the name of the task.

Returns:

String containing the name of the task.

setName

void setName(java.lang.String name)

Sets the name of the task.

Parameters:

name - String containing the new name of the task.

getDescription

java.lang.String getDescription()

Gets the description of the task.

Returns:

String containing the description of the task.

setDescription

void setDescription(java.lang.String description)

Sets the description of the task.

Parameters:

description - String containing the new description of the task.

getStatus

Status getStatus()

Gets the current status of the task.

Specified by:

getStatus in interface InboxItem

Returns:

Status instance representing the current task status.

getCurrentAssignee

java.lang.String getCurrentAssignee()

Gets the id of the owner of the task.

Specified by:

getCurrentAssignee in interface InboxItem

Returns:

String containing the id of the owner of the task.

setCurrentAssignee

void setCurrentAssignee(java.lang.String ownerId)

Sets the id of the owner of the task.

Parameters:

ownerId - String containing the id of the owner of the task.

getTaskTypeName

java.lang.String getTaskTypeName()

Gets the type of this task.

Returns:

String containing the name of the type of this task.

getTimeStarted

java.util.Date getTimeStarted()

Gets the time this task was created.

Specified by:

getTimeStarted in interface InboxItem

Returns:

Date containing the time this task was created.

getCreatedBy

java.lang.String getCreatedBy()

Gets the ID for the user who created the task

Returns:

String containing the create user's ID

getLastModified

java.util.Date getLastModified()

Gets the time this task was last updated.

Returns:

Date containing the time this task was last updated.

getLastModifiedBy

java.lang.String getLastModifiedBy()

Gets the ID for the user who last modified the task

Returns:

String containing the user's ID

getTimeEnded

java.util.Date getTimeEnded()

Gets the time this task was last completed.

Specified by:

getTimeEnded in interface InboxItem

Returns:

Date containing the time this task was completed.

getCompletedBy

java.lang.String getCompletedBy()

Gets the ID for the user who completed the task

Returns:

String containing the complete user's ID

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value)

Sets the property.

Parameters:

name - Name of the property to set.

value - value of named property.

getProperty

java.lang.Object getProperty(java.lang.String aPropertyName)

Gets a property with the given name.

Parameters:

aPropertyName - Name of the property to retrieve.

Returns:

value of the specified property.

getPropertyNames

java.util.Iterator<java.lang.String> getPropertyNames()

Gets an iterator of the property names for this task.

Returns:

an task property name iterator.

setInstructions

void setInstructions(java.lang.String aInstructions)

Sets the instructions for this task.

Parameters:

aInstructions - String containing the new instructions for this task.

getInstructions

java.lang.String getInstructions()

Gets the instructions for this task.

Returns:

String containing the instructions for this task.

getActions

java.util.List<TaskAction> getActions()

returns the list of action objects for this task.

Returns:

list of action objects

setActions

void setActions(java.util.List<TaskAction> aListOfActions)

sets the list of action objects for this task.

Parameters:

aListOfActions - list of action objects

getSelectedAction

TaskAction getSelectedAction()

gets the selected action used to complete the task.

Returns:

action TaskAction represented the action used to compete the task

getSubTasks

java.util.List<Task> getSubTasks()

Returns the list of subtasks for this task

Returns:

the list of subtasks

isSubTaskInfoLoaded

boolean isSubTaskInfoLoaded()

Indicates if this task object is fully populated with sub task information. For performance reasons some task objects may not be fully populated with sub task data.

Returns:

true if the sub tasks are loaded in this task object

hasSubTasks

boolean hasSubTasks()

Returns whether or not there are sub-tasks under this task. Task instances from the server (ie: it does not depend on sub-tasks being actually loaded)

Returns:

true if this task has sub-tasks, false otherwise

getContentPath

java.lang.String getContentPath()

Returns a content path this task is associated with.

Specified by:

getContentPath in interface InboxItem

Returns:

the associated content path

setContentPath

void setContentPath(java.lang.String contentPath)

Sets a content path that this task is associated with.

Parameters:

contentPath - the new content path for this task

setDueTime

void setDueTime(java.util.Date dueTime)

Sets the due time of this task.

Parameters:

dueTime - the new due time of this task

setProgressBeginTime

void setProgressBeginTime(java.util.Date progressBeginTime)

Sets the progress begin time for this task.

Parameters:

progressBeginTime - the time for when progress should start on this task.

setPriority

void setPriority(InboxItem.Priority priority)

Sets the priority for this task.

Parameters:

priority - the priority of this task.