Collaboration API Documentation

com.filenet.bso.api.collaboration.data
Class TaskInfo

java.lang.Object
  |
  +--com.filenet.bso.api.collaboration.data.TaskInfo
All Implemented Interfaces:
java.io.Serializable

public class TaskInfo
extends java.lang.Object
implements java.io.Serializable

The TaskInfo class is a collection of data used to create a teamspace task.

See Also:
Serialized Form

Constructor Summary
protected TaskInfo()
           
  TaskInfo(java.lang.String ownerID, java.lang.String title, java.lang.String description)
           
 
Method Summary
 java.lang.String getDescription()
          Returns the task description.
 java.lang.Boolean getNotifyAssignerOnCompletionFlag()
          Returns true (the default) if the assigner of the task requests email notification on completion of the task.
 java.lang.String getOwnerID()
          Returns the task owner ID.
 java.lang.String getParentTaskID()
          Returns the ID of the parent task of this task.
 java.lang.String getStepWobNo()
          Returns the workflow object number for the workflow step.
 java.lang.String getTaskAssignee()
          Returns the member ID of the user to whom the task is assigned.
 java.lang.String getTaskAssigner()
          Returns the member ID of the task assigner.
 java.util.Date getTaskAssignmentDate()
          Returns the assignment date for the task.
 java.util.Date getTaskDueDate()
          Returns the date on which the assigned task is to be completed.
 java.lang.String getTaskInstructions()
          Returns task instructions for the task.
 int getTaskPriority()
          Returns the priority of the task assignment.
 java.util.Date getTaskReminderDate()
          Returns the reminder date for the task assignment.
 java.lang.String getTitle()
          Returns the title/name of the task.
 java.lang.String getWaitQueueName()
          Returns the name of the workflow queue in which a workflow step is awaiting completion of this task.
 java.lang.String getWorkflowAttachmentsFieldName()
          Returns the name of the workflow field that holds attachments to be used by a teamspace.
 boolean isWorkflowAware()
          Returns whether the task is workflow-aware.
 void setDueDate(java.util.Date dueDate)
          Sets a due date for the task assignment.
 void setInstructions(java.lang.String instructions)
          Sets the instructions for the task assignment.
 void setNotifyAssignerOnCompletionFlag(boolean notifyFlag)
          Set a flag to notify the task assigner on task completion.
 void setParentTaskID(java.lang.String parentTaskID)
          Sets the ID of the parent task to this task.
 void setReminderDate(java.util.Date reminderDate)
          Sets a reminder date for the task assignment.
 void setTaskAssignment(java.lang.String assigner, java.lang.String assignee, java.util.Date assignmentDate)
          Set task assignment information.
 void setTaskPriority(int priority)
          Sets the priority for the task assignment.
 void setWorkflowInfo(boolean isWorkflowAware, java.lang.String waitQueueName, java.lang.String stepWobNo, java.lang.String workflowAttachmentsFieldName)
          Set workflow information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskInfo

protected TaskInfo()

TaskInfo

public TaskInfo(java.lang.String ownerID,
                java.lang.String title,
                java.lang.String description)
Method Detail

getOwnerID

public java.lang.String getOwnerID()
Returns the task owner ID.

Returns:
A String containing the ID of the task owner.

getTitle

public java.lang.String getTitle()
Returns the title/name of the task.

Returns:
A String containing the title/name of the task.

getDescription

public java.lang.String getDescription()
Returns the task description.

Returns:
A String containing the task description.

getTaskAssigner

public java.lang.String getTaskAssigner()
Returns the member ID of the task assigner.

Returns:
A String containing the ID of the task assigner.

getTaskAssignee

public java.lang.String getTaskAssignee()
Returns the member ID of the user to whom the task is assigned.

Returns:
A String containing the ID of the user to whom the task is assigned.

getNotifyAssignerOnCompletionFlag

public java.lang.Boolean getNotifyAssignerOnCompletionFlag()
Returns true (the default) if the assigner of the task requests email notification on completion of the task.

Returns:
A boolean value.

getParentTaskID

public java.lang.String getParentTaskID()
Returns the ID of the parent task of this task.

Returns:
A String containing a task ID.

getTaskDueDate

public java.util.Date getTaskDueDate()
Returns the date on which the assigned task is to be completed.

Returns:
A Date containing the due date for the task assignment.

getTaskReminderDate

public java.util.Date getTaskReminderDate()
Returns the reminder date for the task assignment.

Returns:
A Date containing the reminder date for the task assignment.

getTaskAssignmentDate

public java.util.Date getTaskAssignmentDate()
Returns the assignment date for the task.

Returns:
A Date containing the assignment date for the task.

getTaskPriority

public int getTaskPriority()
Returns the priority of the task assignment.

Returns:
An int containing the priority for the task assignment.

getTaskInstructions

public java.lang.String getTaskInstructions()
Returns task instructions for the task.

Returns:
A String containing task instructions.

setTaskAssignment

public void setTaskAssignment(java.lang.String assigner,
                              java.lang.String assignee,
                              java.util.Date assignmentDate)
Set task assignment information.

Parameters:
assigner - The member ID of the task assigner. Required.

assignee - The member ID of the user assigned this task. Required.

assignmentDate - The date the task was assigned. If null, defaults to the current date.

setParentTaskID

public void setParentTaskID(java.lang.String parentTaskID)
Sets the ID of the parent task to this task.

Parameters:
parentTaskID - The ID of the parent task.

setDueDate

public void setDueDate(java.util.Date dueDate)
Sets a due date for the task assignment.

Parameters:
dueDate - The due date for the task assignment.

setInstructions

public void setInstructions(java.lang.String instructions)
Sets the instructions for the task assignment.

Parameters:
instructions - The instructions for the task assignment.

setReminderDate

public void setReminderDate(java.util.Date reminderDate)
Sets a reminder date for the task assignment.

Parameters:
reminderDate - The reminder date for the task assignment.

setTaskPriority

public void setTaskPriority(int priority)
Sets the priority for the task assignment.

Parameters:
priority - The priority of the task assignment.

setNotifyAssignerOnCompletionFlag

public void setNotifyAssignerOnCompletionFlag(boolean notifyFlag)
Set a flag to notify the task assigner on task completion. Default value is true.

Parameters:
notifyFlag - A boolean value, if true, the task assigner receives an email notification on task completion.

isWorkflowAware

public boolean isWorkflowAware()
Returns 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 if the task is workflow-aware.

getWaitQueueName

public java.lang.String getWaitQueueName()
Returns the name of the workflow queue in which a workflow step is awaiting completion of this task.

Returns:
A String containing the name of the workflow queue.

getStepWobNo

public java.lang.String getStepWobNo()
Returns the workflow object number for the workflow step.

Returns:
A String containing the workflow object number.

getWorkflowAttachmentsFieldName

public java.lang.String getWorkflowAttachmentsFieldName()
Returns the name of the workflow field that holds attachments to be used by a teamspace.

Returns:
A String containing the workflow field name.

setWorkflowInfo

public void setWorkflowInfo(boolean isWorkflowAware,
                            java.lang.String waitQueueName,
                            java.lang.String stepWobNo,
                            java.lang.String workflowAttachmentsFieldName)
Set workflow information.

Parameters:
isWorkflowAware - The value indicating if the task is workflow-aware. Required.

waitQueueName - The workflow queue name which holds the step that is avaiting completion of this task Required.

stepWobNo - The workflow step's work object number for this task Required.

workflowAttachmentsFieldName - The name of the workflow field that holds/recieves attachments. Optional.

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.