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.vo.um 

PrincipalVO  - AS3 Review, Commenting, and Approval
Packagecom.adobe.solutions.rca.vo.um
Classpublic class PrincipalVO
InheritancePrincipalVO Inheritance Object
Subclasses GroupVO, UserVO

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

Defines a principal which can either be a User or a Group.


Public Properties
 PropertyDefined By
  canonicalName : String
The canonical name of this principal.
PrincipalVO
  commonName : String
Common name of the principal.
PrincipalVO
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  description : String
Description of the principal.
PrincipalVO
  directGroupMemberships : IList
Retrieves a set of Group objects indicating those groups to which this principal directly belongs.
PrincipalVO
  domainCommonName : String
The common (display) name of the domain associated with this principal.
PrincipalVO
  domainName : String
Name of the domain associated with this principal.
PrincipalVO
  email : String
The primary email identifier associated with this principal.
PrincipalVO
  emailAlias : String
A list of the secondary email addresses of the principal.
PrincipalVO
  groupMemberships : IList
Retrieves a set of Group objects indicating those groups to which this principal belongs.
PrincipalVO
  local : Boolean
Determines whether this principal is local or not.
PrincipalVO
  locked : Boolean
Determines whether the principal is locked or not.
PrincipalVO
  oid : String
Identifier of the principal.
PrincipalVO
  org : String
The organization to which the principal belongs.
PrincipalVO
  principalType : String
Type of the principal.
PrincipalVO
  roleMembership : IList
Retrieves a set of Role objects indicating those roles which this principal has.
PrincipalVO
  status : String
Status of the principal.
PrincipalVO
  system : Boolean
Determines whether this is a system principal or not.
PrincipalVO
  timestampCreated : String
The timestamp that was created for the principal.
PrincipalVO
  timestampUpdated : String
The timestamp that was updated for the principal.
PrincipalVO
  visibility : int
Retrieves the visibility level of the principal, indicating whether the principal can be shown in the user interface, or whether it qualifies for searches.
PrincipalVO
Public Methods
 MethodDefined By
  
PrincipalVO()
The constructor for PrincipalVO class.
PrincipalVO
 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

canonicalName

property
canonicalName:String

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

The canonical name of this principal. This string is unique within the scope of the domain.



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

commonName

property 
commonName:String

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

Common name of the principal.



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

description

property 
description:String

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

Description of the principal.



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

directGroupMemberships

property 
public var directGroupMemberships:IList

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

Retrieves a set of Group objects indicating those groups to which this principal directly belongs.

domainCommonName

property 
domainCommonName:String

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

The common (display) name of the domain associated with this principal.



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

domainName

property 
domainName:String

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

Name of the domain associated with this principal.



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

email

property 
email:String

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

The primary email identifier associated with this principal.



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

emailAlias

property 
public var emailAlias:String

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

A list of the secondary email addresses of the principal.

groupMemberships

property 
public var groupMemberships:IList

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

Retrieves a set of Group objects indicating those groups to which this principal belongs.

local

property 
public var local:Boolean

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

Determines whether this principal is local or not.

locked

property 
public var locked:Boolean

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

Determines whether the principal is locked or not.

oid

property 
oid:String

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

Identifier of the principal.



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

org

property 
org:String

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

The organization to which the principal belongs.



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

principalType

property 
principalType:String

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

Type of the principal.



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

roleMembership

property 
public var roleMembership:IList

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

Retrieves a set of Role objects indicating those roles which this principal has. The roles returned are either directly assigned or inherited by the principal from its ancestors.

status

property 
status:String

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

Status of the principal.



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

system

property 
public var system:Boolean

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

Determines whether this is a system principal or not.

timestampCreated

property 
public var timestampCreated:String

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

The timestamp that was created for the principal.

timestampUpdated

property 
public var timestampUpdated:String

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

The timestamp that was updated for the principal.

visibility

property 
public var visibility:int

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

Retrieves the visibility level of the principal, indicating whether the principal can be shown in the user interface, or whether it qualifies for searches.

Constructor Detail

PrincipalVO

()Constructor
public function PrincipalVO()

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

The constructor for PrincipalVO class.




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

 

Legal Notices | Online Privacy Policy