|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A class that implements the Task
interface represents work that has been assigned to an individual or
individuals to be performed for an instance of a Teamspace
object. The work performed may result in the
launch of one or more workflows.
Field Summary | |
static int |
CHECK_IF_COMPLETE
|
static int |
CHECK_IF_INPROGRESS
|
static int |
CHECK_IF_PENDING
|
static java.lang.String |
COLLABORATION_TYPE_SYMNAME
Value of "CollaborationType"; Content Engine property. |
static java.lang.String |
DESCRIPTION_SYMNAME
Value of "Description"; Content Engine property. |
static java.lang.String |
MEMBERSHIPMANAGEDSECURITY_SYMNAME
Value of "MembershipManagedSecurity"; Content Engine property. |
static java.lang.String |
NOTIFYWHENTASKCOMPLETED_SYMNAME
Value of "NotifyWhenTaskCompleted"; Content Engine property. |
static java.lang.String |
PENDINGSUBTASKSCOUNT_SYMNAME
Value of "PendingSubtasks"; Content Engine property. |
static java.lang.String[] |
PROPERTIES
String array of persistent properties. |
static java.lang.String |
REOPENEXPLANATION_SYMNAME
Value of "ReopenExplanation"; Content Engine property. |
static java.lang.String |
SECURITYOWNERID_SYMNAME
Value of "SecurityOwnerID"; Content Engine property. |
static java.lang.String |
STATUSEXPLANATION_SYMNAME
Value of "StatusExplanation"; Content Engine property. |
static java.lang.String |
TASKASSIGNEE_SYMNAME
Value of "TaskAssignee"; Content Engine property. |
static java.lang.String |
TASKASSIGNER_SYMNAME
Value of "TaskAssigner"; Content Engine property. |
static java.lang.String |
TASKASSIGNMENTDATE_SYMNAME
Value of "TaskAssignmentDate"; Content Engine property. |
static java.lang.String |
TASKASSIGNMENTS_SYMNAME
Value of "TaskAssignments"; Content Engine property. |
static java.lang.String |
TASKCOMPLETER_SYMNAME
Value of "TaskCompleter"; Content Engine property. |
static java.lang.String |
TASKCOMPLETIONDATE_SYMNAME
Value of "TaskCompletionDate"; Content Engine property. |
static java.lang.String |
TASKDUEDATE_SYMNAME
Value of "TaskDueDate"; Content Engine property. |
static java.lang.String |
TASKHASBEENREASSIGNED_SYMNAME
Value of "TaskHasBeenReassigned"; Content Engine property. |
static java.lang.String |
TASKINPROGRESS_SYMNAME
Value of "TaskInprogress"; Content Engine property. |
static java.lang.String |
TASKINSTRUCTIONS_SYMNAME
Value of "TaskInstructions"; Content Engine property. |
static int |
TASKPRIORITY_HIGH
Value of "1"; Task priority is HIGH. |
static int |
TASKPRIORITY_LOW
Value of "3"; Task priority is LOW. |
static int |
TASKPRIORITY_NORMAL
Value of "2"; Task priority is NORMAL. |
static java.lang.String |
TASKPRIORITY_SYMNAME
Value of "TaskPriority"; Content Engine property. |
static java.lang.String |
TASKREASSIGNMENTDATE_SYMNAME
Value of "TaskReassignmentDate"; Content Engine property. |
static java.lang.String |
TASKREMINDERDATE_SYMNAME
Value of "TaskReminderDate"; Content Engine property. |
static int |
TASKSTATE_ACTIVE
Value of "1"; Task assigned and launched. |
static int |
TASKSTATE_COMPLETE
Value of "8"; Task has completed. |
static int |
TASKSTATE_EXPIRED
Value of "2"; Task due date has been reached. |
static int |
TASKSTATE_NOTASSIGNED
Value of "0"; Task has not been assigned. |
static int |
TASKSTATE_REMINDERSENT
Value of "4"; Task has reached reminder date. |
static java.lang.String |
TASKSTATE_SYMNAME
Value of "TaskState"; Content Engine property. |
static int |
TASKSTATUS_COMPLETE
Value of "4"; Task status is complete. |
static int |
TASKSTATUS_GREEN
Value of "3"; Task status is green. |
static int |
TASKSTATUS_RED
Value of "1"; Task status is red. |
static java.lang.String |
TASKSTATUS_SYMNAME
Value of "TaskStatus"; Content Engine property. |
static int |
TASKSTATUS_YELLOW
Value of "2"; Task status is yellow. |
static java.lang.String |
TASKSTEPWOBNO_SYMNAME
Value of "TaskStepWobNo"; Content Engine property. |
static java.lang.String |
TASKWAITQUEUENAME_SYMNAME
Value of "TaskWaitQueueName"; Content Engine property. |
static java.lang.String |
TASKWORKFLOWATTACHMENTSFIELDNAME_SYMNAME
Value of "TaskWorkflowAttachmentsFieldName"; Content Engine property. |
static java.lang.String |
TASKWORKFLOWAWARE_SYMNAME
Value of "TaskWorkflowAware"; Content Engine property. |
static java.lang.String |
TASKWORKFLOWSTEPDISPATCHED_SYMNAME
Value of "TaskWorkflowStepDispatched"; Content Engine property. |
static java.lang.String |
TEAMSPACE_SYMNAME
Value of "TeamspaceID"; Content Engine property. |
static java.lang.String |
TITLE_SYMNAME
Value of "DocumentTitle"; Content Engine property. |
Method Summary | |
void |
assign(java.lang.String assigner,
java.lang.String assignee,
java.util.Date assignmentDate)
Assign this task. |
void |
bulkUpdate(java.util.Map taskData)
Perform a bulk update of task properties. |
boolean |
checkCondition(int checkTaskCondition)
Determine if a specified task condition is true or false. |
SubjectInfo |
getAssignee()
Returns a SubjectInfo object for the user to whom this task is assigned. |
SubjectInfo |
getAssigner()
Returns a SubjectInfo object for the user who initially assigned this task. |
java.util.Date |
getAssignmentDate()
Returns the date this task was assigned. |
SubjectInfo |
getCompleter()
Returns a SubjectInfo object for the user who completed this task. |
java.util.Date |
getCompletionDate()
Returns the date this task was completed. |
java.lang.String |
getDescription()
Returns the description of this Task object. |
java.util.Date |
getDueDate()
Returns the completion due date for this task. |
java.lang.String |
getInstructions()
Returns instructions for this work (if any). |
java.lang.String |
getName()
Returns the name assigned to the Task object. |
Task |
getParent()
Returns the parent object of this Task object. |
int |
getPendingSubTaskCount()
Returns the number of pending subtasks. |
int |
getPriority()
Get the priority value assigned to the task, TASKPRIORITY_LOW, TASKPRIORITY_NORMAL or TASKPRIORITY_HIGH. |
java.util.Date |
getReminderDate()
Returns the reminder date for this task. |
int |
getState()
Returns the task state, either TASKSTATE_NOTASSIGNED, TASKSTATE_BADDUEDATE, TASKSTATE_ACTIVE, TASKSTATE_REMINDERSENT, TASKSTATE_COMPLETE, or TASKSTATE_PENDING. |
int |
getStatus()
Returns the task status, either TASKSTATUS_RED, TASKSTATUS_YELLOW, TASKSTATUS_GREEN, or TASKSTATUS_COMPLETE. |
java.lang.String |
getStepWorkObjectNumber()
For workflow-aware tasks, returns the workflow object number for the workflow step. |
java.util.Iterator |
getSubTasks()
Returns an iterator to get the sub- Task objects of this Task object. |
java.lang.String |
getSubTasksXML(java.lang.String[] propertyNames,
OrderBy[] sortOrder)
Returns a sorted XML string containing the direct subtasks of this Task object. |
Teamspace |
getTeamspace()
Returns the target Teamspace object. |
java.lang.String |
getWaitQueueName()
For workflow-aware tasks, returns the name of the workflow queue in which the workflow step is waiting. |
java.lang.String |
getWorkflowAttachmentsFieldName()
For workflow-aware tasks, returns the workflow field name that holds attachments. |
boolean |
hasBeenReassigned()
Returns a value indicating whether this task has been reassigned. |
boolean |
hasWorkflowStepBeenDispatched()
Returns a value indicating whether the workflow step associated with the task has been dispatched. |
boolean |
isNotificationSentOnTaskComplete()
Returns true if the task assigner is sent a notification when the task is completed. |
boolean |
isParentTaskOf(Task subtask,
boolean direct)
Returns a value indicating whether the task is an ancestor of a specified task. |
boolean |
isWorkflowAware()
Returns a value indicating whether the task is workflow-aware. |
void |
move(java.lang.String parentID)
Move a task. |
void |
move(Task parent)
Move a task. |
void |
reassign(java.lang.String assigner,
java.lang.String toAssignee,
java.util.Date reassignmentDate)
Reassign a task assignment from one user to another. |
void |
reopen(java.util.Date reopenDate,
java.lang.String reason)
Reopens a task. |
void |
setComplete(java.util.Date completionDate)
Sets the task to a "completed" state, along with the date the task was completed. |
void |
unassign()
Unassign this task. |
Methods inherited from interface com.filenet.bso.api.collaboration.CollaborationObject |
getSymbolicName, getType |
Methods inherited from interface com.filenet.bso.api.collaboration.PersistentBaseObject |
getBaseObject, getID, getObjectStore, getProperties, isMembershipManagedSecurity, isOwner, refresh, setProperties |
Field Detail |
public static final int CHECK_IF_COMPLETE
public static final int CHECK_IF_INPROGRESS
public static final int CHECK_IF_PENDING
public static final java.lang.String DESCRIPTION_SYMNAME
public static final java.lang.String TEAMSPACE_SYMNAME
public static final java.lang.String TITLE_SYMNAME
public static final java.lang.String TASKDUEDATE_SYMNAME
public static final java.lang.String TASKCOMPLETIONDATE_SYMNAME
public static final java.lang.String TASKREMINDERDATE_SYMNAME
public static final java.lang.String TASKASSIGNMENTDATE_SYMNAME
public static final java.lang.String TASKREASSIGNMENTDATE_SYMNAME
public static final java.lang.String TASKINSTRUCTIONS_SYMNAME
public static final java.lang.String TASKINPROGRESS_SYMNAME
public static final java.lang.String TASKHASBEENREASSIGNED_SYMNAME
public static final java.lang.String NOTIFYWHENTASKCOMPLETED_SYMNAME
public static final java.lang.String TASKPRIORITY_SYMNAME
public static final java.lang.String TASKASSIGNER_SYMNAME
public static final java.lang.String TASKASSIGNEE_SYMNAME
public static final java.lang.String TASKCOMPLETER_SYMNAME
public static final java.lang.String TASKSTATE_SYMNAME
public static final java.lang.String TASKSTATUS_SYMNAME
public static final java.lang.String PENDINGSUBTASKSCOUNT_SYMNAME
public static final java.lang.String STATUSEXPLANATION_SYMNAME
public static final java.lang.String REOPENEXPLANATION_SYMNAME
public static final java.lang.String TASKASSIGNMENTS_SYMNAME
public static final java.lang.String TASKWORKFLOWAWARE_SYMNAME
public static final java.lang.String TASKWORKFLOWSTEPDISPATCHED_SYMNAME
public static final java.lang.String TASKWAITQUEUENAME_SYMNAME
public static final java.lang.String TASKWORKFLOWATTACHMENTSFIELDNAME_SYMNAME
public static final java.lang.String TASKSTEPWOBNO_SYMNAME
public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
public static final java.lang.String SECURITYOWNERID_SYMNAME
public static final java.lang.String COLLABORATION_TYPE_SYMNAME
public static final java.lang.String[] PROPERTIES
public static final int TASKSTATE_NOTASSIGNED
public static final int TASKSTATE_ACTIVE
public static final int TASKSTATE_EXPIRED
public static final int TASKSTATE_REMINDERSENT
public static final int TASKSTATE_COMPLETE
public static final int TASKSTATUS_RED
public static final int TASKSTATUS_YELLOW
public static final int TASKSTATUS_GREEN
public static final int TASKSTATUS_COMPLETE
public static final int TASKPRIORITY_HIGH
public static final int TASKPRIORITY_NORMAL
public static final int TASKPRIORITY_LOW
Method Detail |
public Teamspace getTeamspace()
Teamspace
object. Teamspace
object.public java.lang.String getName()
Task
object. String
representing the Task
object's name.public java.lang.String getDescription()
Task
object. String
describing the Task
object.public Task getParent()
Task
object. Task
of this Task
object. Returns null
if this
Task
object has no parent.public SubjectInfo getAssigner()
SubjectInfo
object for the user who initially assigned this task.public SubjectInfo getAssignee()
SubjectInfo
object for the user to whom this task is assigned.public SubjectInfo getCompleter()
SubjectInfo
object for the user who completed this task.public java.util.Date getDueDate()
Date
value.public int getPendingSubTaskCount()
int
value.public java.util.Date getReminderDate()
Date
value.public java.util.Date getCompletionDate()
Date
value.public java.util.Date getAssignmentDate()
Date
value.public java.lang.String getInstructions()
String
value describing the task instructions.public int getPriority()
public int getStatus()
public int getState()
public boolean isNotificationSentOnTaskComplete()
boolean
value indicating whether a task completion notice is sent to the assigner.public java.util.Iterator getSubTasks()
Task
objects of this Task
object. Iterator
to a collection of child Task
objects.public java.lang.String getSubTasksXML(java.lang.String[] propertyNames, OrderBy[] sortOrder)
Task
object. propertyNames
- A String
array containing the property names to include in the XML.sortOrder
- An OrderBy
array that contains the property name and sort order (ASCENDING_SORT
or DESCENDING_SORT) for each property value selected to sort on. Optional; may be null.
String
containing the children of this object.public boolean checkCondition(int checkTaskCondition)
true
if the task is complete. CHECK_IF_INPROGRESS Return
true
if the task is in progress. CHECK_IF_PENDING Return true
if the task
has pending subtasks. boolean
value.public void assign(java.lang.String assigner, java.lang.String assignee, java.util.Date assignmentDate) throws NonTeamspaceMemberException
assignmentDate
- The date this task was assigned. assigner
- The member ID of the user who is assigning this task, if null, current member ID is used. assignee
- The member ID of the user assigned this task. NonTeamspaceMemberException
- if an update is attempted by a non-teamspace member.public void unassign() throws NonTeamspaceMemberException, ValidationException
NonTeamspaceMemberException
- if the update is attempted by a non-teamspace member.public void reassign(java.lang.String assigner, java.lang.String toAssignee, java.util.Date reassignmentDate) throws NonTeamspaceMemberException, ValidationException
assigner
- The member ID of the user who is reassigning this task. If null, the current member ID is used.toAssignee
- The member ID of the user to whom the task is reassigned. reassignmentDate
- The date the task was reassigned.
NonTeamspaceMemberException
- if the update is attempted by a non-teamspace member.public void bulkUpdate(java.util.Map taskData) throws InvalidTargetDateException, NonTeamspaceMemberException, ValidationException
Map
parameter contains the new property values keyed by
property name. The task properties that may updated include (by property name, type): DESCRIPTION_SYMNAME
(String) TASKASSIGNER_SYMNAME (String) TASKDUEDATE_SYMNAME (Date) TASKREMINDERDATE_SYMNAME
(Date) TASKINSTRUCTIONS_SYMNAME (String) TASKPRIORITY_SYMNAME (Integer) TITLE_SYMNAME
(String) NOTIFYWHENTASKCOMPLETED_SYMNAME (Boolean) taskData
- Data to update task properties. InvalidTargetDateException
- if the reminder date or due date is earlier than the current date.NonTeamspaceMemberException
- if the update is attempted by a non-teamspace member.public void setComplete(java.util.Date completionDate) throws NonTeamspaceMemberException, ValidationException, InvalidStateException
completionDate
- The date the task was completed. NonTeamspaceMemberException
- if the update is attempted by a non-teamspace member.public void move(java.lang.String parentID) throws NonTeamspaceMemberException, ValidationException, InvalidStateException, com.filenet.wcm.api.PropertyNotFoundException
parentID
- The ID of the task to use as parent of this task. May be null. NonTeamspaceMemberException
- if the update is attempted by a non-teamspace member.ValidationException
- if object identified by parentID does not exist or is not a task.InvalidStateException
- if an invalid move is attempted.com.filenet.wcm.api.PropertyNotFoundException
- if unable to retrieve a required propertypublic void move(Task parent) throws NonTeamspaceMemberException, ValidationException, InvalidStateException, com.filenet.wcm.api.PropertyNotFoundException
parent
- Task
object to use as parent of this task. May be null. NonTeamspaceMemberException
- if the update is attempted by a non-teamspace member.ValidationException
- if property validation fails.InvalidStateException
- if an invalid move is attempted.com.filenet.wcm.api.PropertyNotFoundException
- if unable to retrieve a required propertypublic void reopen(java.util.Date reopenDate, java.lang.String reason) throws NonTeamspaceMemberException, ValidationException, InvalidStateException
reason
- String
explaining the reason for reopening the task. May be null. reopenDate
- The date the task was reopened. NonTeamspaceMemberException
- if the update is attempted by a non-teamspace member.public boolean hasBeenReassigned()
boolean
value indicating whether the task has been reassigned.public boolean isWorkflowAware()
boolean
that indicates whether the task is workflow-aware.public boolean isParentTaskOf(Task subtask, boolean direct) throws com.filenet.wcm.api.PropertyNotFoundException
subtask
- Task
object to check for ancestry. direct
- True if only immediate ancestor to be checked, False if any ancestor. boolean
that indicates whether the current task is a direct or indirect ancestor of a
specified task.com.filenet.wcm.api.PropertyNotFoundException
- if unable to retrieve a required propertypublic boolean hasWorkflowStepBeenDispatched()
boolean
value indicating whether the workflow step has been dispatched.public java.lang.String getWaitQueueName()
String
containing the name of the workflow queue, or null.public java.lang.String getStepWorkObjectNumber()
String
containing the workflow object number.public java.lang.String getWorkflowAttachmentsFieldName()
String
containing the workflow field names that hold attachments..
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |