ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.solutions.rca.services.impl 

UserManager  - AS3 Review, Commenting, and Approval
Packagecom.adobe.solutions.rca.services.impl
Classpublic class UserManager
InheritanceUserManager Inheritance Object
Implements IUserManager

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This class implements methods exposed for user management.


Public Properties
 PropertyDefined By
  channelSet : ChannelSet
Channel set for remote operation calls.
UserManager
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  instance : IUserManager
[static] [read-only] This operation is used when a single instance of this class is to be shared across the application.
UserManager
Public Methods
 MethodDefined By
  
UserManager()
The constructor for UserManager class.
UserManager
  
findPrincipalById(umOid:String):mx.rpc:AsyncToken
Retrieves a principal according to the specified identifier.
UserManager
  
findPrincipalByName(name:String):mx.rpc:AsyncToken
Retrieves a principal according to the name.
UserManager
  
findPrincipalByPrincipalName(principalName:String):mx.rpc:AsyncToken
Retrieves a principal according to the principal name.
UserManager
  
findPrincipals(principalSearchFilter:PrincipalSearchFilterVO):mx.rpc:AsyncToken
Finds the principals according to the specified search filter.
UserManager
  
findUserByName(name:String):mx.rpc:AsyncToken
Retrieves a user according to the name.
UserManager
  
getPrincipal(domainName:String, cannonicalName:String):mx.rpc:AsyncToken
Retrieves a principal according to the specified domain name and canonical name.
UserManager
 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
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 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

channelSet

property
channelSet:ChannelSet

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Channel set for remote operation calls.



Implementation
    public function get channelSet():ChannelSet
    public function set channelSet(value:ChannelSet):void

instance

property 
instance:IUserManager  [read-only]

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This operation is used when a single instance of this class is to be shared across the application. Using single instance has performance advantage in terms of using client-side cache for user look up.



Implementation
    public static function get instance():IUserManager
Constructor Detail

UserManager

()Constructor
public function UserManager()

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The constructor for UserManager class.

Method Detail

findPrincipalById

()method
public function findPrincipalById(umOid:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Retrieves a principal according to the specified identifier.

Parameters

umOid:String — The principal identifier.

Returns
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the principal to be retrieved.

findPrincipalByName

()method 
public function findPrincipalByName(name:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Retrieves a principal according to the name.

Parameters

name:String — The name of the principal.

Returns
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the principal to be retrieved.

findPrincipalByPrincipalName

()method 
public function findPrincipalByPrincipalName(principalName:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Retrieves a principal according to the principal name.

Parameters

principalName:String — The principal name.

Returns
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the principal to be retrieved.

findPrincipals

()method 
public function findPrincipals(principalSearchFilter:PrincipalSearchFilterVO):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Finds the principals according to the specified search filter.

Parameters

principalSearchFilter:PrincipalSearchFilterVO — The search filter specifying the principals to be returned.

Returns
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains a list containing all the Principal objects found according to the specified search filter.

findUserByName

()method 
public function findUserByName(name:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Retrieves a user according to the name.

Parameters

name:String — The name of the user.

Returns
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the principal to be retrieved.

getPrincipal

()method 
public function getPrincipal(domainName:String, cannonicalName:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Retrieves a principal according to the specified domain name and canonical name.

Parameters

domainName:String — The domain name of the principal.
 
cannonicalName:String — The canonical name of the principal.

Returns
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the principal to be retrieved.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy