ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.foundation.domain 

Group  - AS3 ADEP Workspace

Packagelc.foundation.domain
Classpublic class Group
InheritanceGroup Inheritance Principal Inheritance DomainObject Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The Group class represents a group principal in the Document Server and is used for retrieving the members of a given group.



Public Properties
 PropertyDefined By
 InheritedcanonicalName : String
The user's canonical name.
Principal
 InheritedcommonName : String
The user's common (display) name.
Principal
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheriteddescription : String
A description of the user.
Principal
 InheriteddirectGroupMemberships : ArrayCollection
The groups to which a user directly belongs.
Principal
  domain : String
The user directory's domain name that the user is defined in.
Group
 InheriteddomainCommonName : String
The user's common domain main.
Principal
 InheriteddomainName : String
The user directory's domain name for which the user is defined.
Principal
 Inheritedemail : String
The email address of the user.
Principal
 InheritedemailAliases : Array
The email aliases for the user.
Principal
 InheritedgroupMemberships : ArrayCollection
All groups to which a user belongs.
Principal
  groupType : String
The type of the group.
Group
 Inheritedlocal : Boolean
The user's local value.
Principal
 Inheritedlocked : Boolean
Specifies whether the user is locked.
Principal
 Inheritedoid : String
The unique identifier for the user called a object identifier.
Principal
 Inheritedorg : String
The user's organization name.
Principal
  organization : String
The user's organization name.
Group
 InheritedprincipalType : String
The user's common domain main.
Principal
 InheritedroleMembership : ArrayCollection
The roles to which a user belongs.
Principal
 Inheritedsession : SessionMap
[read-only] A SessionMap object that stores information relating to the server session.
DomainObject
 Inheritedstatus : String
The user's common domain main.
Principal
 Inheritedsystem : Boolean
A flag value that specifies whether the principal is a system principal.
Principal
 Inheritedvisibility : Number
The user's visibility value.
Principal
Public Methods
 MethodDefined By
 Inherited
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.
Principal
 Inherited
Dispatches an event into the event flow.
Principal
  
Retrieves the members of the group.
Group
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Principal
 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
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
Principal
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 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
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
Principal
Property Detail

domain

property
domain:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The user directory's domain name that the user is defined in.

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



Implementation
    public function get domain():String
    public function set domain(value:String):void

groupType

property 
groupType:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The type of the group.

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



Implementation
    public function get groupType():String
    public function set groupType(value:String):void

organization

property 
organization:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The user's organization name.

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



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

getMembers

()method
public function getMembers():lc.foundation.util:CollectionToken

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves the members of the group.

Returns
lc.foundation.util:CollectionToken — A CollectionToken object that represents a collection of users or nested groups.