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.services.impl 

WorkItemManagementService  - AS3 Project Management

Packagecom.adobe.solutions.prm.services.impl
Classpublic class WorkItemManagementService
InheritanceWorkItemManagementService Inheritance Object
Implements IWorkItemManagementService

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

This class defines operations to manage workitems. A workitem is a single unit of work associated with a project. Multiple work items can be associated with a project.



Public Properties
 PropertyDefined By
  channelSet : ChannelSet
Channel set for remote operation calls.
WorkItemManagementService
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
The constructor for WorkItemManagementService class.
WorkItemManagementService
  
This function activates a given workitem.
WorkItemManagementService
  
This function adds a supporting document to a workitem.
WorkItemManagementService
  
This function adds a team member to a workitem.
WorkItemManagementService
  
This function adds a work item to an existing project.
WorkItemManagementService
  
This function creates a workitem using an existing workitem as a template.
WorkItemManagementService
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
This function removes a supporting document from a workitem.
WorkItemManagementService
  
This function removes a team member from a workitem.
WorkItemManagementService
  
removeWorkItem(workItemId:String, forceTerminate:Boolean):mx.rpc:AsyncToken
This function removes a workitem from an existing project.
WorkItemManagementService
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
This function starts a work item immediately.
WorkItemManagementService
  
This function terminates a given work item.
WorkItemManagementService
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
  
This function updates the properties and schedule of a workitem.
WorkItemManagementService
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

channelSet

property
channelSet:ChannelSet

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

Channel set for remote operation calls.



Implementation
    public function get channelSet():ChannelSet
    public function set channelSet(value:ChannelSet):void
Constructor Detail

WorkItemManagementService

()Constructor
public function WorkItemManagementService()

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

The constructor for WorkItemManagementService class.

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.