Packagelc.domain
Classpublic class Group
InheritanceGroup Inheritance Object
Implements IWorkspaceManaged

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


Public Properties
 PropertyDefined By
  canonicalName : String
The canonical name of the group.
Group
  commonName : String
The common name of the group.
Group
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  description : String
The description of the group.
Group
  domain : String
The domain of the group.
Group
  email : String
The email address of the group.
Group
  emailAliases : Array
The email aliases used by the group.
Group
  oid : String
The unique object identifier of the group.
Group
  organization : String
The organization name of the group.
Group
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  session : SessionMap
[read-only] A SessionMap object that stores information relating to the server session.
Group
Public Methods
 MethodDefined By
  
getMembers():CollectionToken
Retrieves the members of the group.
Group
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
setSession(session:SessionMap):void
Specifies a SessionMap object that stores the information relating to the server session.
Group
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
canonicalNameproperty
canonicalName:String  [read-write]

The canonical name of the group.


Implementation
    public function get canonicalName():String
    public function set canonicalName(value:String):void
commonNameproperty 
commonName:String  [read-write]

The common name of the group.


Implementation
    public function get commonName():String
    public function set commonName(value:String):void
descriptionproperty 
description:String  [read-write]

The description of the group.


Implementation
    public function get description():String
    public function set description(value:String):void
domainproperty 
domain:String  [read-write]

The domain of the group.


Implementation
    public function get domain():String
    public function set domain(value:String):void
emailproperty 
email:String  [read-write]

The email address of the group.


Implementation
    public function get email():String
    public function set email(value:String):void
emailAliasesproperty 
emailAliases:Array  [read-write]

The email aliases used by the group.


Implementation
    public function get emailAliases():Array
    public function set emailAliases(value:Array):void
oidproperty 
oid:String  [read-write]

The unique object identifier of the group.


Implementation
    public function get oid():String
    public function set oid(value:String):void
organizationproperty 
organization:String  [read-write]

The organization name of the group.


Implementation
    public function get organization():String
    public function set organization(value:String):void
sessionproperty 
session:SessionMap  [read-only]

A SessionMap object that stores information relating to the server session.


Implementation
    public function get session():SessionMap
Method Detail
getMembers()method
public function getMembers():CollectionToken

Retrieves the members of the group.

Returns
CollectionToken — A collection of users or nested groups.
setSession()method 
public function setSession(session:SessionMap):void

Specifies a SessionMap object that stores the information relating to the server session.

Parameters

session:SessionMap — Specifies the information relating to the server session.




© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Sun Sep 23 2007, 10:15 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/domain/Group.html