Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Task

All Superinterfaces:
CollaborationObject, PersistentBaseObject

public interface Task
extends CollaborationObject, PersistentBaseObject

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 isWorkflowAware()
          Returns a value indicating whether the task is workflow-aware.
 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

CHECK_IF_COMPLETE

public static final int CHECK_IF_COMPLETE

CHECK_IF_INPROGRESS

public static final int CHECK_IF_INPROGRESS

CHECK_IF_PENDING

public static final int CHECK_IF_PENDING

DESCRIPTION_SYMNAME

public static final java.lang.String DESCRIPTION_SYMNAME
Value of "Description"; Content Engine property.

TEAMSPACE_SYMNAME

public static final java.lang.String TEAMSPACE_SYMNAME
Value of "TeamspaceID"; Content Engine property.

TITLE_SYMNAME

public static final java.lang.String TITLE_SYMNAME
Value of "DocumentTitle"; Content Engine property.

TASKDUEDATE_SYMNAME

public static final java.lang.String TASKDUEDATE_SYMNAME
Value of "TaskDueDate"; Content Engine property.

TASKCOMPLETIONDATE_SYMNAME

public static final java.lang.String TASKCOMPLETIONDATE_SYMNAME
Value of "TaskCompletionDate"; Content Engine property.

TASKREMINDERDATE_SYMNAME

public static final java.lang.String TASKREMINDERDATE_SYMNAME
Value of "TaskReminderDate"; Content Engine property.

TASKASSIGNMENTDATE_SYMNAME

public static final java.lang.String TASKASSIGNMENTDATE_SYMNAME
Value of "TaskAssignmentDate"; Content Engine property.

TASKREASSIGNMENTDATE_SYMNAME

public static final java.lang.String TASKREASSIGNMENTDATE_SYMNAME
Value of "TaskReassignmentDate"; Content Engine property.

TASKINSTRUCTIONS_SYMNAME

public static final java.lang.String TASKINSTRUCTIONS_SYMNAME
Value of "TaskInstructions"; Content Engine property.

TASKINPROGRESS_SYMNAME

public static final java.lang.String TASKINPROGRESS_SYMNAME
Value of "TaskInprogress"; Content Engine property.

TASKHASBEENREASSIGNED_SYMNAME

public static final java.lang.String TASKHASBEENREASSIGNED_SYMNAME
Value of "TaskHasBeenReassigned"; Content Engine property.

NOTIFYWHENTASKCOMPLETED_SYMNAME

public static final java.lang.String NOTIFYWHENTASKCOMPLETED_SYMNAME
Value of "NotifyWhenTaskCompleted"; Content Engine property.

TASKPRIORITY_SYMNAME

public static final java.lang.String TASKPRIORITY_SYMNAME
Value of "TaskPriority"; Content Engine property.

TASKASSIGNER_SYMNAME

public static final java.lang.String TASKASSIGNER_SYMNAME
Value of "TaskAssigner"; Content Engine property.

TASKASSIGNEE_SYMNAME

public static final java.lang.String TASKASSIGNEE_SYMNAME
Value of "TaskAssignee"; Content Engine property.

TASKCOMPLETER_SYMNAME

public static final java.lang.String TASKCOMPLETER_SYMNAME
Value of "TaskCompleter"; Content Engine property.

TASKSTATE_SYMNAME

public static final java.lang.String TASKSTATE_SYMNAME
Value of "TaskState"; Content Engine property.

TASKSTATUS_SYMNAME

public static final java.lang.String TASKSTATUS_SYMNAME
Value of "TaskStatus"; Content Engine property.

PENDINGSUBTASKSCOUNT_SYMNAME

public static final java.lang.String PENDINGSUBTASKSCOUNT_SYMNAME
Value of "PendingSubtasks"; Content Engine property.

STATUSEXPLANATION_SYMNAME

public static final java.lang.String STATUSEXPLANATION_SYMNAME
Value of "StatusExplanation"; Content Engine property.

REOPENEXPLANATION_SYMNAME

public static final java.lang.String REOPENEXPLANATION_SYMNAME
Value of "ReopenExplanation"; Content Engine property.

TASKASSIGNMENTS_SYMNAME

public static final java.lang.String TASKASSIGNMENTS_SYMNAME
Value of "TaskAssignments"; Content Engine property.

TASKWORKFLOWAWARE_SYMNAME

public static final java.lang.String TASKWORKFLOWAWARE_SYMNAME
Value of "TaskWorkflowAware"; Content Engine property.

TASKWORKFLOWSTEPDISPATCHED_SYMNAME

public static final java.lang.String TASKWORKFLOWSTEPDISPATCHED_SYMNAME
Value of "TaskWorkflowStepDispatched"; Content Engine property.

TASKWAITQUEUENAME_SYMNAME

public static final java.lang.String TASKWAITQUEUENAME_SYMNAME
Value of "TaskWaitQueueName"; Content Engine property.

TASKWORKFLOWATTACHMENTSFIELDNAME_SYMNAME

public static final java.lang.String TASKWORKFLOWATTACHMENTSFIELDNAME_SYMNAME
Value of "TaskWorkflowAttachmentsFieldName"; Content Engine property.

TASKSTEPWOBNO_SYMNAME

public static final java.lang.String TASKSTEPWOBNO_SYMNAME
Value of "TaskStepWobNo"; Content Engine property.

MEMBERSHIPMANAGEDSECURITY_SYMNAME

public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
Value of "MembershipManagedSecurity"; Content Engine property.

SECURITYOWNERID_SYMNAME

public static final java.lang.String SECURITYOWNERID_SYMNAME
Value of "SecurityOwnerID"; Content Engine property.

COLLABORATION_TYPE_SYMNAME

public static final java.lang.String COLLABORATION_TYPE_SYMNAME
Value of "CollaborationType"; Content Engine property.

PROPERTIES

public static final java.lang.String[] PROPERTIES
String array of persistent properties.

TASKSTATE_NOTASSIGNED

public static final int TASKSTATE_NOTASSIGNED
Value of "0"; Task has not been assigned.

TASKSTATE_ACTIVE

public static final int TASKSTATE_ACTIVE
Value of "1"; Task assigned and launched.

TASKSTATE_EXPIRED

public static final int TASKSTATE_EXPIRED
Value of "2"; Task due date has been reached.

TASKSTATE_REMINDERSENT

public static final int TASKSTATE_REMINDERSENT
Value of "4"; Task has reached reminder date.

TASKSTATE_COMPLETE

public static final int TASKSTATE_COMPLETE
Value of "8"; Task has completed.

TASKSTATUS_RED

public static final int TASKSTATUS_RED
Value of "1"; Task status is red.

TASKSTATUS_YELLOW

public static final int TASKSTATUS_YELLOW
Value of "2"; Task status is yellow.

TASKSTATUS_GREEN

public static final int TASKSTATUS_GREEN
Value of "3"; Task status is green.

TASKSTATUS_COMPLETE

public static final int TASKSTATUS_COMPLETE
Value of "4"; Task status is complete.

TASKPRIORITY_HIGH

public static final int TASKPRIORITY_HIGH
Value of "1"; Task priority is HIGH.

TASKPRIORITY_NORMAL

public static final int TASKPRIORITY_NORMAL
Value of "2"; Task priority is NORMAL.

TASKPRIORITY_LOW

public static final int TASKPRIORITY_LOW
Value of "3"; Task priority is LOW.
Method Detail

getTeamspace

public Teamspace getTeamspace()
Returns the target Teamspace object.

Returns:
A Teamspace object.

getName

public java.lang.String getName()
Returns the name assigned to the Task object.

Returns:
A String representing the Task object's name.

getDescription

public java.lang.String getDescription()
Returns the description of this Task object.

Returns:
A String describing the Task object.

getParent

public Task getParent()
Returns the parent object of this Task object.

Returns:
The parent Task of this Task object. Returns null if this Task object has no parent.

getAssigner

public SubjectInfo getAssigner()
Returns a SubjectInfo object for the user who initially assigned this task.

getAssignee

public SubjectInfo getAssignee()
Returns a SubjectInfo object for the user to whom this task is assigned.

getCompleter

public SubjectInfo getCompleter()
Returns a SubjectInfo object for the user who completed this task.

getDueDate

public java.util.Date getDueDate()
Returns the completion due date for this task.

Returns:
A Date value.

getPendingSubTaskCount

public int getPendingSubTaskCount()
Returns the number of pending subtasks.

Returns:
An int value.

getReminderDate

public java.util.Date getReminderDate()
Returns the reminder date for this task.

Returns:
A Date value.

getCompletionDate

public java.util.Date getCompletionDate()
Returns the date this task was completed.

Returns:
A Date value.

getAssignmentDate

public java.util.Date getAssignmentDate()
Returns the date this task was assigned.

Returns:
A Date value.

getInstructions

public java.lang.String getInstructions()
Returns instructions for this work (if any).

Returns:
A String value describing the task instructions.

getPriority

public int getPriority()
Get the priority value assigned to the task, TASKPRIORITY_LOW, TASKPRIORITY_NORMAL or TASKPRIORITY_HIGH.

Returns:
The ID of a workflow reference object in the Collaboration Store.

getStatus

public int getStatus()
Returns the task status, either TASKSTATUS_RED, TASKSTATUS_YELLOW, TASKSTATUS_GREEN, or TASKSTATUS_COMPLETE.

Returns:
The current task status.

getState

public int getState()
Returns the task state, either TASKSTATE_NOTASSIGNED, TASKSTATE_BADDUEDATE, TASKSTATE_ACTIVE, TASKSTATE_REMINDERSENT, TASKSTATE_COMPLETE, or TASKSTATE_PENDING.

Returns:
The current task state.

isNotificationSentOnTaskComplete

public boolean isNotificationSentOnTaskComplete()
Returns true if the task assigner is sent a notification when the task is completed.

Returns:
A boolean value indicating whether a task completion notice is sent to the assigner.

getSubTasks

public java.util.Iterator getSubTasks()
Returns an iterator to get the sub- Task objects of this Task object.

Returns:
An Iterator to a collection of child Task objects.

getSubTasksXML

public java.lang.String getSubTasksXML(java.lang.String[] propertyNames,
                                       OrderBy[] sortOrder)
Returns a sorted XML string containing the direct subtasks of this Task object.

Parameters:
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.

Returns:
An XML String containing the children of this object.

checkCondition

public boolean checkCondition(int checkTaskCondition)
Determine if a specified task condition is true or false.

Conditions which may be checked:

CHECK_IF_COMPLETE Return 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.

Returns:
A boolean value.

assign

public void assign(java.lang.String assigner,
                   java.lang.String assignee,
                   java.util.Date assignmentDate)
            throws NonTeamspaceMemberException
Assign this task.

Parameters:
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.

assignmentDate - The date this task was assigned.

Throws:
NonTeamspaceMemberException - if an update is attempted by a non-teamspace member.

unassign

public void unassign()
              throws NonTeamspaceMemberException,
                     ValidationException
Unassign this task.

Throws:
NonTeamspaceMemberException - if the update is attempted by a non-teamspace member.

reassign

public void reassign(java.lang.String assigner,
                     java.lang.String toAssignee,
                     java.util.Date reassignmentDate)
              throws NonTeamspaceMemberException,
                     ValidationException
Reassign a task assignment from one user to another.

Parameters:
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.

Throws:
NonTeamspaceMemberException - if the update is attempted by a non-teamspace member.

bulkUpdate

public void bulkUpdate(java.util.Map taskData)
                throws InvalidTargetDateException,
                       NonTeamspaceMemberException,
                       ValidationException
Perform a bulk update of task properties. The 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)

Parameters:
taskData - Data to update task properties.

Throws:
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.

setComplete

public void setComplete(java.util.Date completionDate)
                 throws NonTeamspaceMemberException,
                        ValidationException,
                        InvalidStateException
Sets the task to a "completed" state, along with the date the task was completed.

Parameters:
completionDate - The date the task was completed.

Throws:
NonTeamspaceMemberException - if the update is attempted by a non-teamspace member.

reopen

public void reopen(java.util.Date reopenDate,
                   java.lang.String reason)
            throws NonTeamspaceMemberException,
                   ValidationException,
                   InvalidStateException
Reopens a task. Reopening a task sets the internal state to either NOT_ASSIGNED or ACTIVE, and clears the due date, reminder date, and completion date.

Parameters:
reopenDate - The date the task was reopened.

reason - String explaining the reason for reopening the task. May be null.

Throws:
NonTeamspaceMemberException - if the update is attempted by a non-teamspace member.

hasBeenReassigned

public boolean hasBeenReassigned()
Returns a value indicating whether this task has been reassigned.

Returns:
A boolean value indicating whether the task has been reassigned.

isWorkflowAware

public boolean isWorkflowAware()
Returns a value indicating whether the task is workflow-aware. If the task is workflow-aware, the workflow is waiting for the collaboration task to be completed.

Returns:
A boolean that indicates whether the task is workflow-aware.

hasWorkflowStepBeenDispatched

public boolean hasWorkflowStepBeenDispatched()
Returns a value indicating whether the workflow step associated with the task has been dispatched.

Returns:
A boolean value indicating whether the workflow step has been dispatched.

getWaitQueueName

public java.lang.String getWaitQueueName()
For workflow-aware tasks, returns the name of the workflow queue in which the workflow step is waiting. Returns null for tasks not associated with a workflow.

Returns:
A String containing the name of the workflow queue, or null.

getStepWorkObjectNumber

public java.lang.String getStepWorkObjectNumber()
For workflow-aware tasks, returns the workflow object number for the workflow step. Returns null for tasks not associated with a workflow.

Returns:
A String containing the workflow object number.

getWorkflowAttachmentsFieldName

public java.lang.String getWorkflowAttachmentsFieldName()
For workflow-aware tasks, returns the workflow field name that holds attachments. Returns null for tasks not associated with a workflow.

Returns:
A String containing the workflow field names that hold attachments..

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.