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 

ReviewSearchFilterVO  - AS3 Review, Commenting, and Approval

Packagecom.adobe.solutions.rca.vo
Classpublic class ReviewSearchFilterVO
InheritanceReviewSearchFilterVO Inheritance BaseVO Inheritance 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 reviews.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  customAttributes : Object
Map of custom attributes.
ReviewSearchFilterVO
  endDate : Date
End date of the review.
ReviewSearchFilterVO
 Inheritedid : String
Get the ID of the VO.
BaseVO
  keywords : String
Keywords to search for.
ReviewSearchFilterVO
  name : String
Name of the review search filter.
ReviewSearchFilterVO
  pageNumber : int
Page number in case the results are paginated.
ReviewSearchFilterVO
  pageSize : int
Page size in case the results need to be paginated.
ReviewSearchFilterVO
  role : String
Constrains results for the current users role.
ReviewSearchFilterVO
  searchGroupBasedReviews : Boolean
Flag to search reviews, which are assigned to groups of which the user is a memeber.
ReviewSearchFilterVO
  startDate : Date
Start date of the review.
ReviewSearchFilterVO
  statusFilterList : IList
Returns a list of review status types.
ReviewSearchFilterVO
  templateName : String
Name of template used to define the review.
ReviewSearchFilterVO
  umOid : String
OID of the user performing the search.
ReviewSearchFilterVO
Public Methods
 MethodDefined By
  
The constructor for ReviewSearchFilterVO class.
ReviewSearchFilterVO
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  DEFAULT_PAGE_SIZE : int = 25
[static] Page size in case of paginated results.
ReviewSearchFilterVO
  LAST_PAGE : int = -1
[static] Set the page number to LAST_PAGE to fetch the last page of the paginated results.
ReviewSearchFilterVO
Property Detail

customAttributes

property
customAttributes:Object

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

Map of custom attributes.



Implementation
    public function get customAttributes():Object
    public function set customAttributes(value:Object):void

endDate

property 
endDate:Date

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

End date of the review.



Implementation
    public function get endDate():Date
    public function set endDate(value:Date):void

keywords

property 
keywords:String

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

Keywords to search for.



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

name

property 
name: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 review search filter.



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

pageNumber

property 
pageNumber:int

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

Page number in case the results are paginated.



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

pageSize

property 
pageSize:int

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

Page size in case the results need to be paginated.



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

role

property 
role:String

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

Constrains results for the current users role.



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

searchGroupBasedReviews

property 
searchGroupBasedReviews:Boolean

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

Flag to search reviews, which are assigned to groups of which the user is a memeber.



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

startDate

property 
startDate:Date

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

Start date of the review.



Implementation
    public function get startDate():Date
    public function set startDate(value:Date):void

statusFilterList

property 
statusFilterList:IList

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

Returns a list of review status types.



Implementation
    public function get statusFilterList():IList
    public function set statusFilterList(value:IList):void

templateName

property 
templateName: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 template used to define the review.



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

umOid

property 
umOid: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 user performing the search.



Implementation
    public function get umOid():String
    public function set umOid(value:String):void
Constructor Detail

ReviewSearchFilterVO

()Constructor
public function ReviewSearchFilterVO()

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 ReviewSearchFilterVO class.

Constant Detail

DEFAULT_PAGE_SIZE

Constant
public static const DEFAULT_PAGE_SIZE:int = 25

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

Page size in case of paginated results.

LAST_PAGE

Constant 
public static const LAST_PAGE:int = -1

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

Set the page number to LAST_PAGE to fetch the last page of the paginated results.