|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.filenet.bso.api.collaboration.data.TaskInfo
The TaskInfo
class is a collection of data used to create a teamspace task.
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 |
protected TaskInfo()
public TaskInfo(java.lang.String ownerID, java.lang.String title, java.lang.String description)
Method Detail |
public java.lang.String getOwnerID()
String
containing the ID of the task owner.public java.lang.String getTitle()
String
containing the title/name of the task.public java.lang.String getDescription()
String
containing the task description.public java.lang.String getTaskAssigner()
String
containing the ID of the task assigner.public java.lang.String getTaskAssignee()
String
containing the ID of the user to whom the task is assigned.public java.lang.Boolean getNotifyAssignerOnCompletionFlag()
true
(the default) if the assigner of the task requests
email notification on completion of the task.
boolean
value.public java.lang.String getParentTaskID()
String
containing a task ID.public java.util.Date getTaskDueDate()
Date
containing the due date for the task assignment.public java.util.Date getTaskReminderDate()
Date
containing the reminder date for the task assignment.public java.util.Date getTaskAssignmentDate()
Date
containing the assignment date for the task.public int getTaskPriority()
int
containing the priority for the task assignment.public java.lang.String getTaskInstructions()
String
containing task instructions.public void setTaskAssignment(java.lang.String assigner, java.lang.String assignee, java.util.Date assignmentDate)
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.public void setParentTaskID(java.lang.String parentTaskID)
parentTaskID
- The ID of the parent task.public void setDueDate(java.util.Date dueDate)
dueDate
- The due date for the task assignment.public void setInstructions(java.lang.String instructions)
instructions
- The instructions for the task assignment.public void setReminderDate(java.util.Date reminderDate)
reminderDate
- The reminder date for the task assignment.public void setTaskPriority(int priority)
priority
- The priority of the task assignment.public void setNotifyAssignerOnCompletionFlag(boolean notifyFlag)
true
.
notifyFlag
- A boolean
value, if true
,
the task assigner receives an email notification on task completion.public boolean isWorkflowAware()
boolean
that indicates if the task is workflow-aware.public java.lang.String getWaitQueueName()
String
containing the name of the workflow queue.public java.lang.String getStepWobNo()
String
containing the workflow object number.public java.lang.String getWorkflowAttachmentsFieldName()
String
containing the workflow field name.public void setWorkflowInfo(boolean isWorkflowAware, java.lang.String waitQueueName, java.lang.String stepWobNo, java.lang.String workflowAttachmentsFieldName)
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 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |