Package com.adobe.idp.taskmanager.dsc.client.task
Interfacepublic interface CreateTaskInfo

This interface is used to create a new task. To create a task in the system, populate all of the relevant values for a particular task and call TaskManager.createTask().



Public Methods
 MethodDefined by
  
void addACLsForSharedQueues(boolean createACLs)
Sets whether access control lists should be set for users who have access to the queue to which the new task is assigned.
CreateTaskInfo
  
void copyAttachments(boolean copyAttachments)
Copies attachments from the previous task.
CreateTaskInfo
  
void isStartTask(boolean startTask)
Determines whether this is a start task.
CreateTaskInfo
  
void setActionId(long actionId)
Sets the action identifier that corresponds to this task, if this task is part of an orchestration.
CreateTaskInfo
  
Defines to whom the task will be assigned.
CreateTaskInfo
  
void setAttachmentDocumentList(List attachmentDocs)
Copies the attachments from a list of documents to the task attachments.
CreateTaskInfo
  
void setConsultGroup(String groupDomainId, String groupCanonicalName)
Sets the consult group based on the domain identifier and group canonical name.
CreateTaskInfo
  
void setConsultGroupId(String consultGroupId)
Sets an identifier for the group with which users can consult on this task.
CreateTaskInfo
  
void setDeadline(Date deadline)
Sets a deadline for the task.
CreateTaskInfo
  
void setDeadlineInstructions(String deadlineInstructions)
Sets deadline instructions to be used if a deadline fires.
CreateTaskInfo
  
void setDeadlineRouteName(String deadlineRouteName)
Sets which route to follow for a long-lived task when a deadline fires.
CreateTaskInfo
  
void setDefaultACLs(TaskACL defaultACL)
Sets the default access control list (ACL) for this task.
CreateTaskInfo
  
void setDescription(String descriptionText)
Sets a description of this task for the user.
CreateTaskInfo
  
Defines to whom the task will be escalated when TaskManager#escalateTask TaskManager.escalateTask() is called.
CreateTaskInfo
  
void setEscalation(Date escalation)
Sets an escalation for the task.
CreateTaskInfo
  
void setFirstReminder(Date reminder)
Sets a reminder for the task.
CreateTaskInfo
  
void setForwardGroup(String groupDomainId, String groupCanonicalName)
Sets the forward group based on the domain identifier and group canonical name.
CreateTaskInfo
  
void setForwardGroupId(String forwardGroupId)
Sets an identifier for the group to which users can forward this task.
CreateTaskInfo
  
void setInstructions(String instructionsText)
Sets the instructions metadata (text) associated with the task.
CreateTaskInfo
  
void setLongLivedInvocationId(String aInvocationId)
Provides the task with a way to store the long-lived invocation that created the task.
CreateTaskInfo
  
void setPriority(short priority)
Sets a priority for this task.
CreateTaskInfo
  
void setProcessInstanceId(long processId)
Sets the process identifier for this task.
CreateTaskInfo
  
void setProcessName(String aProcessName)
Provides the opportunity for an orchestrated service calling TaskManager#createTask TaskManager.createTask() to provide the process name.
CreateTaskInfo
  
void setReminderInstructions(String aReminderInstructions)
Sets instructions for the task once a reminder is issued.
CreateTaskInfo
  
void setReminderRepeatMinutes(long reminderRepeatMinutes)
Sets a time, in minutes, for reminders to be issued after the initial reminder.
CreateTaskInfo
  
void setRouteList(String[] routes)
Sets a route list for the user to choose from.
CreateTaskInfo
  
void setRouteSelectionRequired(boolean routeRequired)
Sets whether it is required that a user choose a route before completing the task.
CreateTaskInfo
  
void setSelectedRoute(String selectedRoute)
Sets the default selected route.
CreateTaskInfo
  
void setStepName(String stepName)
Sets the step name for this task.
CreateTaskInfo
  
void setTaskACLs(TaskACL[] acls)
Sets an access control list for this task.
CreateTaskInfo
  
void setTaskItems(FormInstance[] forms)
Sets the task items (sometimes called Forms) for the task.
CreateTaskInfo
  
void showAttachments(boolean showAttachments)
A hint for the user interface that indicates whether to show the attachment window for this task.
CreateTaskInfo
Method Detail
addACLsForSharedQueues()
public void addACLsForSharedQueues(boolean createACLs)

Sets whether access control lists should be set for users who have access to the queue to which the new task is assigned. The default is true (for backwards compatibility).

Parameters

createACLstrue if access control lists should be set for users who have access to the queue to which the new task is assigned, false otherwise.

copyAttachments() 
public void copyAttachments(boolean copyAttachments)
Deprecated: This is still supported for backwards compatibility. However, the method of storing a list of documents for task attachments is preferred.

Copies attachments from the previous task.

Parameters

copyAttachments — The attachments from the previous task.

isStartTask() 
public void isStartTask(boolean startTask)

Determines whether this is a start task.

Parameters

startTasktrue if this is a start task, false otherwise.

setActionId() 
public void setActionId(long actionId)

Sets the action identifier that corresponds to this task, if this task is part of an orchestration.

Parameters

actionId — The action identifier that corresponds to this task.

setAssignTo() 
public void setAssignTo(ParticipantInfo assignTo)

Defines to whom the task will be assigned.

Parameters

assignTo — A ParticipantInfo object indicating to whom the task will be assigned.

setAttachmentDocumentList() 
public void setAttachmentDocumentList(List attachmentDocs)

Copies the attachments from a list of documents to the task attachments.

Parameters

attachmentDocs — The list of documents containing the attachments.

setConsultGroup() 
public void setConsultGroup(String groupDomainId, String groupCanonicalName)

Sets the consult group based on the domain identifier and group canonical name. This method is provided because these values identify a group that is universal across deployments using the same user domain setup.

Parameters

groupDomainId — The domain identifier for the group.
 
groupCanonicalName — The group's canonical name.

setConsultGroupId() 
public void setConsultGroupId(String consultGroupId)

Sets an identifier for the group with which users can consult on this task. If this value is set, this task may only be consulted with members of the indicated group.

Parameters

consultGroupId — The identifier of the group with which users can consult on this task.

setDeadline() 
public void setDeadline(Date deadline)

Sets a deadline for the task.

Parameters

deadline — A Date object indicating a deadline for the task.

setDeadlineInstructions() 
public void setDeadlineInstructions(String deadlineInstructions)

Sets deadline instructions to be used if a deadline fires.

Parameters

deadlineInstructions — A String with new instructions for the task.

setDeadlineRouteName() 
public void setDeadlineRouteName(String deadlineRouteName)

Sets which route to follow for a long-lived task when a deadline fires.

Parameters

deadlineRouteName — A String representing the valid outbound route to follow from this step in the process.

setDefaultACLs() 
public void setDefaultACLs(TaskACL defaultACL)

Sets the default access control list (ACL) for this task. When a user is given access to the task or has the task forwarded to him, this default ACL will be used to populate the newly assigned user's ACL.

Parameters

defaultACL — The default access control list (ACL) for this task.

setDescription() 
public void setDescription(String descriptionText)

Sets a description of this task for the user.

Parameters

descriptionText — The description of this task.

setEscalateTo() 
public void setEscalateTo(ParticipantInfo escalateTo)

Defines to whom the task will be escalated when TaskManager.escalateTask() is called.

Parameters

escalateTo — A ParticipantInfo object indicating to whom the task will be escalated.

setEscalation() 
public void setEscalation(Date escalation)

Sets an escalation for the task. You must also specify to whom the task should be escalated.

Parameters

escalation — A Date object indicating when to the escalate the task.

setFirstReminder() 
public void setFirstReminder(Date reminder)

Sets a reminder for the task.

Parameters

reminder — A Date object indicating when to issue the reminder for the task.

setForwardGroup() 
public void setForwardGroup(String groupDomainId, String groupCanonicalName)

Sets the forward group based on the domain identifier and group canonical name. This method is provided because these values identify a group that is universal across deployments using the same user domain setup.

Parameters

groupDomainId — The domain identifier for the group.
 
groupCanonicalName — The group's canonical name.

setForwardGroupId() 
public void setForwardGroupId(String forwardGroupId)

Sets an identifier for the group to which users can forward this task. If this value is set, this task may only be forwarded to members of the indicated group.

Parameters

forwardGroupId — The identifier of the group to which to allow forwarding.

setInstructions() 
public void setInstructions(String instructionsText)

Sets the instructions metadata (text) associated with the task. These instructions are normally for the user to whom this task is assigned. They appear in end user applications or email notifications.

Parameters

instructionsText — Instructions for the user.

setLongLivedInvocationId() 
public void setLongLivedInvocationId(String aInvocationId)

Provides the task with a way to store the long-lived invocation that created the task. The invocation should be notified when the task is complete.

Parameters

aInvocationId — A job identifier for the invocation request.

setPriority() 
public void setPriority(short priority)

Sets a priority for this task.

Parameters

priority — The priority for this task.

See also

setProcessInstanceId() 
public void setProcessInstanceId(long processId)

Sets the process identifier for this task.

Parameters

processId — The process identifier for this task.

setProcessName() 
public void setProcessName(String aProcessName)

Provides the opportunity for an orchestrated service calling TaskManager.createTask() to provide the process name.

Parameters

aProcessName — The name of the process with which this task is associated.

setReminderInstructions() 
public void setReminderInstructions(String aReminderInstructions)

Sets instructions for the task once a reminder is issued.

Parameters

aReminderInstructions — The new instructions for the task upon issuing the reminder.

setReminderRepeatMinutes() 
public void setReminderRepeatMinutes(long reminderRepeatMinutes)

Sets a time, in minutes, for reminders to be issued after the initial reminder. These reminders will be issued until the task is completed.

Parameters

reminderRepeatMinutes — The number of minutes after the initial reminder for another reminder to be sent.

setRouteList() 
public void setRouteList(String[] routes)

Sets a route list for the user to choose from. The list will be used to follow a particular route in an orchestration.

Parameters

routes — A route list for the user to choose from.

setRouteSelectionRequired() 
public void setRouteSelectionRequired(boolean routeRequired)

Sets whether it is required that a user choose a route before completing the task.

Parameters

routeRequiredtrue if a user must choose a route before completing the task, false otherwise.

setSelectedRoute() 
public void setSelectedRoute(String selectedRoute)

Sets the default selected route.

Parameters

selectedRoute — The default selected route.

setStepName() 
public void setStepName(String stepName)

Sets the step name for this task. This item usually contains the action name from an orchestration.

Parameters

stepName

setTaskACLs() 
public void setTaskACLs(TaskACL[] acls)

Sets an access control list for this task.

Parameters

acls — The access control list for this task.

See also

setTaskItems() 
public void setTaskItems(FormInstance[] forms)

Sets the task items (sometimes called Forms) for the task.

Parameters

forms — An array of FormInstance objects representing the task items.

showAttachments() 
public void showAttachments(boolean showAttachments)

A hint for the user interface that indicates whether to show the attachment window for this task.

Parameters

showAttachmentstrue if the attachment window for this task should be shown, false otherwise.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/taskmanager/dsc/client/task/CreateTaskInfo.html