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

IUserManager  - AS3 ADEP Workspace

Packagelc.foundation
Interfacepublic interface IUserManager extends IManager , IEventDispatcher
Implementors UserManager

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 IUserManager interface contains methods for finding users and groups.

Related API Elements



Public Properties
 PropertyDefined By
 InheritedfaultHandler : Function
The default fault handler function.
IManager
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
IEventDispatcher
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
  
Retrieves the groups that match the specified substring.
IUserManager
  
Retrieves the users that match the specified substring.
IUserManager
  
Retrieves a list of users who have a common name, who are members in the group specified by the group's OID.
IUserManager
  
Retrieves the users that match the specified substring and have invoke permissions to the service.
IUserManager
 Inherited
Determines whether the default operation is prevented.
IManager
 Inherited
Determines whether the default operation is prevented.
IManager
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Method Detail

findGroups

()method
public function findGroups(commonNamePattern:String):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 groups that match the specified substring. The matching is performed against the display name of the group. For example, "ample" would match groups named SampleOrganization. Matching is not case-sensitive.

Parameters

commonNamePattern:String — Specifies a substring to match.

Returns
lc.foundation.util:CollectionToken — A token containing a collection of Group objects when the request completes. Set result and fault handlers on the token that executes when the invocation completes and the collection is populated.

findUsers

()method 
public function findUsers(commonNamePattern:String):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 users that match the specified substring. A match is made against the display name of the user. For example, "ikira" would match "Akira Tanaka". Matching is not case-sensitive.

Parameters

commonNamePattern:String — Specifies a substring to match.

Returns
lc.foundation.util:CollectionToken — A token containing a collection of User objects when the request completes. Set result and fault handlers on the token that executes when the invocation completes and the collection is populated.

findUsersInGroup

()method 
public function findUsersInGroup(groupOid:String, commonNamePattern:String = null):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 a list of users who have a common name, who are members in the group specified by the group's OID. If the commonNamePattern parameter is not supplied, it will return the users who are members of the group specified by the groupOID parameter.

Parameters

groupOid:String — Specifies the OID of the group.
 
commonNamePattern:String (default = null) — Specifies the common name of the user(s). The default is null.

Returns
lc.foundation.util:CollectionToken — A token containing a collection of User objects when the request completes. Set result and fault handlers on the token that executes when the invocation completes and the collection is populated.

findUsersWithPermission

()method 
public function findUsersWithPermission(commonNamePattern:String, serviceName:String):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 users that match the specified substring and have invoke permissions to the service. The matching is performed against the display name of the user. For example, ikira would match Akira Tanaka. Matching is not case sensitive.

Parameters

commonNamePattern:String — Specifies a substring to match.
 
serviceName:String — Specifies the service name.

Returns
lc.foundation.util:CollectionToken — A token containing a collection of User objects when the request completes. Set result and fault handlers on the token that executes when the invocation completes and the collection is populated.