PrincipalSearchFilterVO

Package	com.adobe.solutions.rca.vo.um
Class	public class PrincipalSearchFilterVO
Inheritance	PrincipalSearchFilterVO Object

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Defines properties used for searching principals.

Public Properties

	Property		Defined By
		canonicalName : String Canonical name used to search for principals.	PrincipalSearchFilterVO
		commonName : String Common name used to search for principals.	PrincipalSearchFilterVO
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		email : String Email to search.	PrincipalSearchFilterVO
		principalOid : String Oid of the principal to search.	PrincipalSearchFilterVO
		principalType : String Type of principal for search namely, USER and GROUP.	PrincipalSearchFilterVO
		resultMax : int The maximum number of results to be displayed.	PrincipalSearchFilterVO
		retrieveOnlyActive : Boolean Whether to search for active principals only.	PrincipalSearchFilterVO
		specificDomainName : String The specific domain identifier used to search for principals.	PrincipalSearchFilterVO
		userId : String User identifier on which the search is based.	PrincipalSearchFilterVO
		visibility : int The visibility level on which to base the search.	PrincipalSearchFilterVO

Public Methods

	Method		Defined By
		PrincipalSearchFilterVO() The constructor of PrincipalSearchFilterVO class.	PrincipalSearchFilterVO
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		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)

Canonical name used to search for principals.

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 used to search for principals.

Implementation
public function get commonName():String
public function set commonName(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)

Email to search.

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

principalOid

property

principalOid:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Oid of the principal to search.

Implementation
public function get principalOid():String
public function set principalOid(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 principal for search namely, USER and GROUP.

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

resultMax

property

resultMax:int

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The maximum number of results to be displayed.

Implementation
public function get resultMax():int
public function set resultMax(value:int):void

retrieveOnlyActive

property

retrieveOnlyActive:Boolean

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Whether to search for active principals only. By default, both active and deleted principals are returned.

Implementation
public function get retrieveOnlyActive():Boolean
public function set retrieveOnlyActive(value:Boolean):void

specificDomainName

property

specificDomainName:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The specific domain identifier used to search for principals.

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

userId

property

userId:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

User identifier on which the search is based.

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

visibility

property

visibility:int

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The visibility level on which to base the search.

Implementation
public function get visibility():int
public function set visibility(value:int):void

Constructor Detail