| Package | com.adobe.solutions.prm.domain.impl |
| Class | public class TeamMember |
| Inheritance | TeamMember  Object |
| Implements | ITeamMember, IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| asset : IAsset [read-only]
A reference of the asset to which the team member is assigned. | TeamMember | ||
| assignedTo : IMemberCollection [read-only]
Reference to the member collection to which this member is assigned. | TeamMember | ||
| attributes : Object
Defines the map of key value pair attributes. | TeamMember | ||
| campaignRole : String
The role of a team member in a campaign. | TeamMember | ||
| canonicalName : String [read-only]
CanonicalName of the member as defined in Document Server User Management. | TeamMember | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| createdBy : String
Principal name for a user who created an entity. | TeamMember | ||
| creationDate : Date
Date of creation of an entity. | TeamMember | ||
| description : String
Description. | TeamMember | ||
| domainName : String [read-only]
Domain name of the member as defined in Document Server User Management. | TeamMember | ||
| email : String [read-only]
Email of the member. | TeamMember | ||
| id : String
Unique identifier. | TeamMember | ||
| lastUpdatedBy : String
Principal name for a user who last updated an entity. | TeamMember | ||
| lastUpdatedDate : Date
Date when an entity was last updated. | TeamMember | ||
| name : String [read-only]
Name of the member. | TeamMember | ||
| organizationalTitle : String
Defines the organization title. | TeamMember | ||
| principalName : String
Defines the Principal Name of a team member. | TeamMember | ||
| project : IProject [read-only]
Reference of the project to which this team member is assigned. | TeamMember | ||
| projectName : String [read-only]
The name of the project to which the team member is assigned. | TeamMember | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| role : String [read-only]
Role of the member in the workflow. | TeamMember | ||
| tags : IList
Defines the list of tags that can be associated with an entity. | TeamMember | ||
| title : String [read-only]
Title of the member in the workflow. | TeamMember | ||
| user : IUser
User object is fetched based on principal name attribute of team member value object. | TeamMember | ||
| userId : String [read-only]
User ID of a team member as defined in Adobe ® Digital Enterprise Platform Document Services - Administration Console. | TeamMember | ||
| vo : com.adobe.solutions.prm.vo:TeamMemberVO
This property refers to an instance of a team member value object. | TeamMember | ||
| workItem : IWorkItem [read-only]
A reference of the workitem to which the team member is assigned. | TeamMember | ||
| Method | Defined By | ||
|---|---|---|---|
The constructor for TeamMember class. | TeamMember | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | TeamMember | ||
Dispatches an event into the event flow. | TeamMember | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | TeamMember | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
This remote operation removes a team member from the server. | TeamMember | ||
Removes a listener from the EventDispatcher object. | TeamMember | ||
This remote operation saves the current state of team member on server. | TeamMember | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | TeamMember | ||
asset | property |
assignedTo | property |
assignedTo:IMemberCollection [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Reference to the member collection to which this member is assigned.
Implementation
public function get assignedTo():IMemberCollectionattributes | property |
attributes:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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):voidcampaignRole | property |
campaignRole:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The role of a team member in a campaign. These roles are assigned by virtue of being owner of a project or workitem.
Implementation
public function get campaignRole():String public function set campaignRole(value:String):voidcanonicalName | property |
canonicalName:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
CanonicalName of the member as defined in Document Server User Management.
The combination of canonicalName and domainName are used to uniquely identify a user.
This property can be used as the source for data binding. When this property is modified, it dispatches the userUpdated event.
Implementation
public function get canonicalName():StringcreatedBy | property |
createdBy:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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):voidcreationDate | property |
description | property |
domainName | property |
domainName:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Domain name of the member as defined in Document Server User Management.
The combination of canonicalName and domainName are used to uniquely identify a user.
This property can be used as the source for data binding. When this property is modified, it dispatches the userUpdated event.
Implementation
public function get domainName():String| property |
id | property |
lastUpdatedBy | property |
lastUpdatedBy:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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):voidlastUpdatedDate | property |
lastUpdatedDate:Date| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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):voidname | property |
name:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Name of the member.
This property can be used as the source for data binding. When this property is modified, it dispatches the userUpdated event.
Implementation
public function get name():StringorganizationalTitle | property |
organizationalTitle:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the organization title. Please note that this value is not validated. It is a user-defined value. You can add the validation in a custom implementation.
Implementation
public function get organizationalTitle():String public function set organizationalTitle(value:String):voidprincipalName | property |
principalName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the Principal Name of a team member.
Implementation
public function get principalName():String public function set principalName(value:String):voidproject | property |
projectName | property |
role | property |
tags | property |
tags:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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):voidtitle | property |
user | property |
user:IUser| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
User object is fetched based on principal name attribute of team member value object.
Implementation
public function get user():IUser public function set user(value:IUser):voiduserId | property |
userId:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
User ID of a team member as defined in Adobe ® Digital Enterprise Platform Document Services - Administration Console.
This property can be used as the source for data binding. When this property is modified, it dispatches the userUpdated event.
Implementation
public function get userId():Stringvo | property |
vo:com.adobe.solutions.prm.vo:TeamMemberVO| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This property refers to an instance of a team member value object.
Implementation
public function get vo():com.adobe.solutions.prm.vo:TeamMemberVO public function set vo(value:com.adobe.solutions.prm.vo:TeamMemberVO):voidworkItem | property |
TeamMember | () | Constructor |
public function TeamMember(value:com.adobe.solutions.prm.vo:TeamMemberVO, project:IProject, workItem:IWorkItem)| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The constructor for TeamMember class. It creates a team member using team member value object and reference to project or work item
to which this member is assigned.
value:com.adobe.solutions.prm.vo:TeamMemberVO — Team member value object
| |
project:IProject — Reference of project to which this team member is assigned.
| |
workItem:IWorkItem — Reference of workitem to which this team member is assigned.
|
addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):voidRegisters 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
type:String — The type of event.
| |
listener:Function — The listener function that processes the event. This function must accept an event object
as its only parameter and must return nothing, as this example shows:
| |
useCapture:Boolean (default = false)useCapture is set to true, the
listener processes the event only during the capture phase and not in the target or
bubbling phase. If useCapture is false, the listener processes the event only
during the target or bubbling phase. To listen for the event in all three phases, call
addEventListener() twice, once with useCapture set to true,
then again with useCapture set to false.
| |
priority:int (default = 0) | |
weakRef:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
dispatchEvent | () | method |
public function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. The event target is the
EventDispatcher object upon which dispatchEvent() is called.
Parameters
event:Event — The event object dispatched into the event flow.
|
Boolean — A value of true unless preventDefault() is called on the event,
in which case it returns false.
|
hasEventListener | () | method |
public function hasEventListener(type:String):Boolean
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
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
remove | () | method |
public function remove():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation removes a team member from the server. It removes a member from the list of members present at that level from which this member is removed.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a list of all the team members present at that level from which this member is removed.
|
removeEventListener | () | method |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):voidRemoves 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
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false)removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.
|
save | () | method |
public function save():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation saves the current state of team member on server. It adds this member to a list of members present at that level to which this member is added.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a list of the team members present at that level to which this member is added.
|
willTrigger | () | method |
public function willTrigger(type:String):Boolean
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
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Mon Nov 28 2011, 06:48 AM -08:00