ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.solutions.prm.service 

IWorkItemManagementService  - AS3 Project Management

Packagecom.adobe.solutions.prm.service
Interfacepublic interface IWorkItemManagementService
Implementors WorkItemManagementService

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This interface defines operations to manage a work item. A work item is a single unit of work associated with a project. There can be many work items associated with a project.



Public Methods
 MethodDefined By
  
This function activates a given workitem.
IWorkItemManagementService
  
This function adds a supporting document to a workitem.
IWorkItemManagementService
  
This function adds a team member to a workitem.
IWorkItemManagementService
  
This function adds a work item to an existing project.
IWorkItemManagementService
  
This function creates a workitem using an existing workitem as a template.
IWorkItemManagementService
  
This function removes a supporting document from a workitem.
IWorkItemManagementService
  
This function removes a team member from a workitem.
IWorkItemManagementService
  
removeWorkItem(workItemId:String, forceTerminate:Boolean):mx.rpc:AsyncToken
This function removes a workitem from an existing project.
IWorkItemManagementService
  
This function starts a work item immediately.
IWorkItemManagementService
  
This function terminates a given work item.
IWorkItemManagementService
  
This function updates the properties and schedule of a workitem.
IWorkItemManagementService
Method Detail

activateWorkItem

()method
public function activateWorkItem(workItemId:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function activates a given workitem.

Parameters

workItemId:String — The identifier of the workitem to be activated.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a value object of the activated workitem.

addSupportingDocument

()method 
public function addSupportingDocument(workItemId:String, supportingDocument:DocumentVO):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function adds a supporting document to a workitem.

Parameters

workItemId:String — The identifier of the workitem to which a supporting document is to be added.
 
supportingDocument:DocumentVO — An instance of a supporting document.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

addTeamMember

()method 
public function addTeamMember(workItemId:String, member:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function adds a team member to a workitem.

Parameters

workItemId:String — The identifier of the workitem to which a team member is to be added.
 
member:com.adobe.solutions.prm.vo:TeamMemberVO — An instance of the team member to be added.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a list of team members associated with the workitem.

addWorkItem

()method 
public function addWorkItem(projectId:String, workItem:WorkItemVO):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function adds a work item to an existing project.

Parameters

projectId:String — The project identifier of the project to which a workitem is to be added.
 
workItem:WorkItemVO — The WorkItem value object to be added.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the value object of the added workitem.

createWorkItemFromTemplate

()method 
public function createWorkItemFromTemplate(workItemId:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function creates a workitem using an existing workitem as a template.

Parameters

workItemId:String — The identifier for the workitem that is to be used as a template.

Returns
mx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached. The resulting event contains a value object of the newly created workitem.

removeSupportingDocument

()method 
public function removeSupportingDocument(workItemId:String, supportingDocument:DocumentVO):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function removes a supporting document from a workitem.

Parameters

workItemId:String — An identifier of the workitem from which a supporting document is to be removed.
 
supportingDocument:DocumentVO — An instance of a supporting document.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

removeTeamMember

()method 
public function removeTeamMember(workItemId:String, member:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function removes a team member from a workitem.

Parameters

workItemId:String — The identifier of the workitem from which a team member is to be removed.
 
member:com.adobe.solutions.prm.vo:TeamMemberVO — An instance of the team member to be removed.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a list of team members associated with the workitem.

removeWorkItem

()method 
public function removeWorkItem(workItemId:String, forceTerminate:Boolean):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function removes a workitem from an existing project.

Parameters

workItemId:String — The identifier of the workitem to be removed.
 
forceTerminate:Boolean — If this Boolean flag is set to True, the system terminates the workflow running in that workitem.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the value object of the removed workitem.

startWorkItem

()method 
public function startWorkItem(workItemId:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function starts a work item immediately.

Parameters

workItemId:String — The identifier of a workitem to be started.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a value object of the started workitem.

terminateWorkItem

()method 
public function terminateWorkItem(workItemId:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function terminates a given work item.

Parameters

workItemId:String — The identifier of the workitem to be terminated.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a reference to the terminated workitem.

updateWorkItem

()method 
public function updateWorkItem(workItem:WorkItemVO):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This function updates the properties and schedule of a workitem.

Parameters

workItem:WorkItemVO — A WorkItem value object with updated values.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a value object of the updated workitem.