WorkItem  - AS3 Project Management

The property returns a collection of all members. It takes into consideration any child objects that may be of type IMemberCollection.

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

Defines the asset of WorkItem.

Defines the map of key value pair attributes.

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.

Principal name for a user who created an entity.

Date of creation of an entity.

Description.

The property returns a collection of associated documents.

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

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.

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

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.

A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.

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

Unique identifier.

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.

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

End date of the item.

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

Name of the item.

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

Start date of the item.

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

State of the item.

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

Status of the item.

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

Type of item.

Principal name for a user who last updated an entity.

Date when an entity was last updated.

The property returns a collection of directly associated members.

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

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.

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

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.

A collection of operations that are available to a user through the context menu in the Gantt chart.

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.

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.

Defines the reference documents associated with a workItem.

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.

Related API Elements

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

Related API Elements

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

A Boolean flag to determine if the children need to be displayed.

A Boolean flag to determine if the parent needs to be displayed.

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.

Defines the state of a WorkItem.

Defines the status of a WorkItem.

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

Related API Elements

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

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.

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.

The property returns a collection of unique members.

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

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

Related API Elements

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.

The constructor of WorkItem class. It creates a workitem using workitem value object and reference to parent project and root project.

This remote operation activates the current workitem.

This remote operation adds a document from the collection and submits the change on the server.

Parameters

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

This remote operation adds a member to the collection and submits the change to the server.

Parameters

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

Parameters

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

Parameters

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

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

Parameters

A Boolean function to determine if the item has displayable children.

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

This remote operation removes itself from its parent project and updates the change on a server.

This remote operation removes a document from the collection and submits the change on the server.

Parameters

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

This remote operation removes a member from the collection and submits the change to the server.

Parameters

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

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

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

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.

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.

This remote operation updates the tile of a member present in collection and submits the change to the server.

Parameters

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters