com.adobe.solutions.prm.domain

# IWorkItem - AS3 Project Management

Package | com.adobe.solutions.prm.domain
Interface | public interface IWorkItem extends IGanttDataItem , IMemberCollection , IDocumentCollection
Implementors | WorkItem

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

An interface for defining a WorkItem domain object. A WorkItem describes an unit of work within a project. A WorkItem can have a workflow associated with it.

Related API Elements

com.adobe.solutions.prm.vo.WorkItemVO

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | allMemberList : IList [read-only] The property returns a collection of all members. | IMemberCollection
|  | asset : IAsset Defines the asset of WorkItem. | IWorkItem
|  | attributes : Object Defines the map of key value pair attributes. | IWorkItem
|  | context : IReviewContext [read-only] This property returns a reference to the workflow template that will be used by the work item. | IWorkItem
|  | createdBy : String Principal name for a user who created an entity. | IWorkItem
|  | creationDate : Date Date of creation of an entity. | IWorkItem
|  | description : String Description. | IWorkItem
|  | documents : ArrayCollection [read-only] The property returns a collection of associated documents. | IDocumentCollection
|  | editedTemplate : Boolean Defines the current value of editedTemplate flag. | IWorkItem
|  | endDate : Date Defines the end date of a workItem. | IWorkItem
|  | expectedEndDate : Date Defines the expected end date for a workItem. | IWorkItem
|  | ganttItems : ArrayCollection [read-only] A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True. | IGanttDataItem
|  | id : String Unique identifier. | IWorkItem
|  | inheritDocsFromParent : Boolean Defines the current value of inheritDocsFromParent flag. | IWorkItem
|  | instanceId : String Defines the instance ID of the workflow associated with a workItem. | IWorkItem
|  | itemEndDate : Date [read-only] End date of the item. | IGanttDataItem
|  | itemName : String [read-only] Name of the item. | IGanttDataItem
|  | itemStartDate : Date [read-only] Start date of the item. | IGanttDataItem
|  | itemState : String [read-only] State of the item. | IGanttDataItem
|  | itemStatus : String [read-only] Status of the item. | IGanttDataItem
|  | itemType : String [read-only] Type of item. | IGanttDataItem
|  | lastUpdatedBy : String Principal name for a user who last updated an entity. | IWorkItem
|  | lastUpdatedDate : Date Date when an entity was last updated. | IWorkItem
|  | memberList : IList [read-only] The property returns a collection of directly associated members. | IMemberCollection
|  | members : IList Defines a list of members of the project. | IWorkItem
|  | name : String Defines the name of the workItem, workItem name is a mandatory attribute should not be null. | IWorkItem
|  | operationList : ArrayCollection [read-only] A collection of operations that are available to a user through the context menu in the Gantt chart. | IGanttDataItem
|  | owner : IUser Defines the owner of a workItem. | IWorkItem
|  | parentProject : IProject Defines the immediate parent of a workItem in the project hierarchy. | IWorkItem
|  | referenceDocuments : IList Defines the reference documents associated with a workItem. | IWorkItem
|  | reviewContextList : IList [read-only] Defines the list of reviewContext List, If the workitem is has a running instance of review associated with it, then it gives list of review context each corresponding to a different revision of review. | IWorkItem
|  | reviewTemplate : com.adobe.solutions.rca.domain:IReviewTemplate Defines the reivewTemplate. | IWorkItem
|  | rootProject : IProject Defines the root project. | IWorkItem
|  | showChildren : Boolean A Boolean flag to determine if the children need to be displayed. | IGanttDataItem
|  | showParent : Boolean A Boolean flag to determine if the parent needs to be displayed. | IGanttDataItem
|  | startDate : Date Defines start date of a workItem. | IWorkItem
|  | state : String Defines the state of a WorkItem. | IWorkItem
|  | status : String Defines the status of a WorkItem. | IWorkItem
|  | statusReasonCode : String Defines the status reason code. | IWorkItem
|  | tags : IList Defines the list of tags that can be associated with an entity. | IWorkItem
|  | templateName : String Defines the workItem template name. | IWorkItem
|  | type : String Defines the type of workItem. | IWorkItem
|  | uniqueMemberList : IList [read-only] The property returns a collection of unique members. | IMemberCollection
|  | vo : WorkItemVO This property refers to an instance of a workItem value object. | IWorkItem
|  | workflowDisposition : String Stores additional status information about the status of workflow associated with a workItem. | IWorkItem

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | activate():mx.rpc:AsyncToken This remote operation activates the current workitem. | IWorkItem
|  | addDocumentAndSave(doc:ISupportingDocument):mx.rpc:AsyncToken This remote operation adds a document from the collection and submits the change on the server. | IDocumentCollection
|  | addMemberAndSave(member:IMember):mx.rpc:AsyncToken This remote operation adds a member to the collection and submits the change to the server. | IMemberCollection
|  | addReferenceDocument(doc:ISupportingDocument):void This method adds a reference document to the referenceDocuments collection. | IWorkItem
|  | addTeamMember(teamMember:com.adobe.solutions.prm.domain:ITeamMember):void This method adds a team member to the collection of the members. | IWorkItem
|  | getMemberTitle(member:IMember):String This method returns the title of the member, if any title is assigned to the user. | IWorkItem
|  | hasChildren():Boolean A Boolean function to determine if the item has displayable children. | IGanttDataItem
|  | remove():mx.rpc:AsyncToken This remote operation removes itself from its parent project and updates the change on a server. | IWorkItem
|  | removeDocumentAndSave(doc:ISupportingDocument):mx.rpc:AsyncToken This remote operation removes a document from the collection and submits the change on the server. | IDocumentCollection
|  | removeMemberAndSave(member:IMember):mx.rpc:AsyncToken This remote operation removes a member from the collection and submits the change to the server. | IMemberCollection
|  | removeMemberAt(index:int):com.adobe.solutions.prm.domain:ITeamMember This method removes a team member, at the specified index, from the collections of the members. | IWorkItem
|  | removeReferenceDocumentAt(index:int):ISupportingDocument This method removes a reference document, at the specified index, from the referenceDocuments collection. | IWorkItem
|  | restartSchedule(file:File, stageNumber:int):mx.rpc:AsyncToken This remote operation restarts the workflow attached to a workitem. | IWorkItem
|  | save():mx.rpc:AsyncToken This remote operation saves the current state of a workitem on a server. | IWorkItem
|  | terminate():mx.rpc:AsyncToken This remote operation terminates the current workitem. | IWorkItem
|  | updateTitleAndSave(member:IMember, title:String):mx.rpc:AsyncToken This remote operation updates the tile of a member present in collection and submits the change to the server. | IMemberCollection

Property Detail

### asset

property

`asset:IAsset`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the asset of WorkItem.

Implementation
`public function get asset():IAsset`
`public function set asset(value:IAsset):void`

### attributes

property

`attributes:Object`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the map of key value pair attributes.

Implementation
`public function get attributes():Object`
`public function set attributes(value:Object):void`

### context

property

`context:IReviewContext` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This property returns a reference to the workflow template that will be used by the work item. A local template is returned if attached, else parent template is returned.

Implementation
`public function get context():IReviewContext`

### createdBy

property

`createdBy:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Principal name for a user who created an entity.

Implementation
`public function get createdBy():String`
`public function set createdBy(value:String):void`

### creationDate

property

`creationDate:Date`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Date of creation of an entity.

Implementation
`public function get creationDate():Date`
`public function set creationDate(value:Date):void`

### description

property

`description:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Description.

Implementation
`public function get description():String`
`public function set description(value:String):void`

### editedTemplate

property

`editedTemplate:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the current value of `editedTemplate` flag. If this Boolean flag is set to `True`, a template has been locally modified for this work item.

Implementation
`public function get editedTemplate():Boolean`
`public function set editedTemplate(value:Boolean):void`

### endDate

property

`endDate:Date`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the end date of a workItem. As the end date is a calculated field, client should never call the setter.

Implementation
`public function get endDate():Date`
`public function set endDate(value:Date):void`

### expectedEndDate

property

`expectedEndDate:Date`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the expected end date for a workItem. If `expectedEndDate` is `null`, then it is inherited from the parent project. For this reason, a root project can not have a `null` value for the expected end date.

Implementation
`public function get expectedEndDate():Date`
`public function set expectedEndDate(value:Date):void`

### id

property

`id:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Unique identifier.

Implementation
`public function get id():String`
`public function set id(value:String):void`

### inheritDocsFromParent

property

`inheritDocsFromParent:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the current value of `inheritDocsFromParent` flag. If this Boolean flag is set to `True`, the workItem inherits the reference documents from parent project and so on. If the flag is set to `False`, then it does not inherit reference documents.

Implementation
`public function get inheritDocsFromParent():Boolean`
`public function set inheritDocsFromParent(value:Boolean):void`

### instanceId

property

`instanceId:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the instance ID of the workflow associated with a workItem. Instance ID uniquely identifies an ongoing workflow instance.

Implementation
`public function get instanceId():String`
`public function set instanceId(value:String):void`

### lastUpdatedBy

property

`lastUpdatedBy:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Principal name for a user who last updated an entity.

Implementation
`public function get lastUpdatedBy():String`
`public function set lastUpdatedBy(value:String):void`

### lastUpdatedDate

property

`lastUpdatedDate:Date`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Date when an entity was last updated.

Implementation
`public function get lastUpdatedDate():Date`
`public function set lastUpdatedDate(value:Date):void`

### members

property

`members:IList`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines a list of members of the project. Replaces any existing list of members. Team members get a notification of various events during a workItem life cycle.

Implementation
`public function get members():IList`
`public function set members(value:IList):void`

### name

property

`name:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the name of the workItem, workItem name is a mandatory attribute should not be `null`. [ ] / | * . .. : and trailing spaces are not allowed in the name.

Implementation
`public function get name():String`
`public function set name(value:String):void`

### owner

property

`owner:IUser`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the owner of a workItem. Owner information is based on the Principal Name of the user present in WorkItemVO.

This property can be used as the source for data binding. When this property is modified, it dispatches the `ownerUpdated` event.

Implementation
`public function get owner():IUser`
`public function set owner(value:IUser):void`

### parentProject

property

`parentProject:IProject`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the immediate parent of a workItem in the project hierarchy. Since a project can have only one immediate parent, only a single instance of project is returned. Please note that for the first level children in a project hierarchy, parent project or root project have the same value. Parent project value is `null` for a root project itself.

Implementation
`public function get parentProject():IProject`
`public function set parentProject(value:IProject):void`

### referenceDocuments

property

`referenceDocuments:IList`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the reference documents associated with a workItem.

Implementation
`public function get referenceDocuments():IList`
`public function set referenceDocuments(value:IList):void`

### reviewContextList

property

`reviewContextList:IList` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the list of `reviewContext` List, If the workitem is has a running instance of review associated with it, then it gives list of review context each corresponding to a different revision of review.

Implementation
`public function get reviewContextList():IList`

Related API Elements

com.adobe.solutions.rca.domain.IReviewContext

### reviewTemplate

property

`reviewTemplate:com.adobe.solutions.rca.domain:IReviewTemplate`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the `reivewTemplate`. It keeps the edited value or the populated value of a review template, based on `templateName`.

Implementation
`public function get reviewTemplate():com.adobe.solutions.rca.domain:IReviewTemplate`
`public function set reviewTemplate(value:com.adobe.solutions.rca.domain:IReviewTemplate):void`

Related API Elements

com.adobe.solutions.rca.domain.IReviewTemplate

### rootProject

property

`rootProject:IProject`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the root project. This method is used internally and should not be used by a client.

Implementation
`public function get rootProject():IProject`
`public function set rootProject(value:IProject):void`

### startDate

property

`startDate:Date`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines start date of a workItem. If start date is set in future, then workItem is scheduled to start on the future date. If start date is in past or current date, then such a workItem starts, as soon as the workItem is activated. If the start date of a workItem is `null`, then the start date is inherited from the parent project.

Implementation
`public function get startDate():Date`
`public function set startDate(value:Date):void`

### state

property

`state:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the state of a WorkItem.

Implementation
`public function get state():String`
`public function set state(value:String):void`

### status

property

`status:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the status of a WorkItem.

Implementation
`public function get status():String`
`public function set status(value:String):void`

### statusReasonCode

property

`statusReasonCode:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the status reason code. Reason codes provide more information about the status and provide reason for specific status being set. In the default implementation, it has only two status, red and green

Implementation
`public function get statusReasonCode():String`
`public function set statusReasonCode(value:String):void`

Related API Elements

com.adobe.solutions.prm.constant.StatusReasonCode

### tags

property

`tags:IList`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the list of tags that can be associated with an entity.

Implementation
`public function get tags():IList`
`public function set tags(value:IList):void`

### templateName

property

`templateName:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the workItem template name. Every workItem is associated with a RCA template. If a template is not directly assigned to a workItem, then a template is inherited from a parent project in the hierarchy, going from bottom to top. You need to specify only the template name, since it is unique. Ensure that the template exists before it is used.

Implementation
`public function get templateName():String`
`public function set templateName(value:String):void`

### type

property

`type:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines the type of workItem. This attribute is not used in the current implementation, but the provided value is stored and associated with the workItem. A custom implementation can use the type, if required.

Implementation
`public function get type():String`
`public function set type(value:String):void`

### vo

property

`vo:WorkItemVO`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This property refers to an instance of a workItem value object.

Implementation
`public function get vo():WorkItemVO`
`public function set vo(value:WorkItemVO):void`

Related API Elements

com.adobe.solutions.prm.vo.WorkItemVO

### workflowDisposition

property

`workflowDisposition:String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Stores additional status information about the status of workflow associated with a workItem. It is not used in the current implementation. It is reserved for future use.

Implementation
`public function get workflowDisposition():String`
`public function set workflowDisposition(value:String):void`
Method Detail

### activate

()
method

`public function activate():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 remote operation activates the current workitem.

Returns

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

### addReferenceDocument

()
method

`public function addReferenceDocument(doc:ISupportingDocument):void`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This method adds a reference document to the `referenceDocuments` collection. It adds the document locally and not on a server.

Parameters

| `doc:ISupportingDocument` — A reference document to be added.

### addTeamMember

()
method

`public function addTeamMember(teamMember:com.adobe.solutions.prm.domain:ITeamMember):void`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This method adds a team member to the collection of the members. It adds the team member locally and not on a server.

Parameters

| `teamMember:com.adobe.solutions.prm.domain:ITeamMember` — Team Member to be added.

### getMemberTitle

()
method

`public function getMemberTitle(member:IMember):String`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This method returns the title of the member, if any title is assigned to the user.

Parameters

| `member:IMember` — Member instance whose title is required.

Returns

| `String` — It returns the title of the member.

Related API Elements

IProject.users

### remove

()
method

`public function remove():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 remote operation removes itself from its parent project and updates the change on a server.

Returns

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

### removeMemberAt

()
method

`public function removeMemberAt(index:int):com.adobe.solutions.prm.domain:ITeamMember`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This method removes a team member, at the specified index, from the collections of the members. It removes a team member locally and not on a server.

Parameters

| `index:int` — Index of the member to be removed.

Returns

| `com.adobe.solutions.prm.domain:ITeamMember` — It returns a reference to the removed member.

### removeReferenceDocumentAt

()
method

`public function removeReferenceDocumentAt(index:int):ISupportingDocument`

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This method removes a reference document, at the specified index, from the `referenceDocuments` collection. It removes the document locally and not on a server.

Parameters

| `index:int` — Index of the document to be removed.

Returns

| `ISupportingDocument` — It returns a reference to the removed document.

### restartSchedule

()
method

`public function restartSchedule(file:File, stageNumber:int):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 remote operation restarts the workflow attached to a workitem. While restarting a new file can be provided, to be used in the restarted workflow. User has the option of restarting a schedule from a specific stage.

Parameters

| `file:File` — New asset to be used in the restarted workflow.
| `stageNumber:int` — Stage number from which the schedule should restarted.

Returns

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

### save

()
method

`public function save():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 remote operation saves the current state of a workitem on a server. If save is successful, it refreshes the current object with the new value object returned from the server.

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 saved workitem.

### terminate

()
method

`public function terminate():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 remote operation terminates the current workitem. If the operation is successful, it refreshes current object with the new value object returned from a server.

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 terminated workitem.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00