ReviewSearchFilter

Package	com.adobe.livecycle.rca.model
Class	public class ReviewSearchFilter
Inheritance	ReviewSearchFilter Object
Implements	IEventDispatcher

Deprecated since Review, Commenting, and Approval 10: Please Use com.adobe.solutions.rca.vo.ReviewSearchFilterVO

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Defines properties that are used to search reviews.

Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		customAttributes : Object Specifies a map of custom attributes.	ReviewSearchFilter
		endDate : Date Specifies the end date of the review.	ReviewSearchFilter
		keywords : String Specifies keywords in the review title or purpose to search for.	ReviewSearchFilter
		name : String Specifies the name of the review search filter.	ReviewSearchFilter
		pageNumber : int Specifies a page number.	ReviewSearchFilter
		pageSize : int Specifies a page size.	ReviewSearchFilter
		role : String Specifies constraints for the results by user and role.	ReviewSearchFilter
		searchGroupBasedReviews : Boolean Specifies whether to search reviews that are assigned to groups that the user belongs to.	ReviewSearchFilter
		startDate : Date Specifies the start date of the review.	ReviewSearchFilter
		statusFilterList : Array Specifies a list of review status types to retrieve.	ReviewSearchFilter
		templateName : String Specifies the name of the template that is used to create the review.	ReviewSearchFilter
		umOid : String Specifies the Object Identifier of the user who is performing the search.	ReviewSearchFilter

Public Methods

	Method		Defined By
		ReviewSearchFilter() Filter class that is used to search review templates when using the searchReviews API.	ReviewSearchFilter
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	ReviewSearchFilter
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ReviewSearchFilter
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ReviewSearchFilter
		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
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	ReviewSearchFilter
		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
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	ReviewSearchFilter

Public Constants

	Constant		Defined By
		APPROVER_ROLE : String = "APPROVER" [static] Specifies the approver role.	ReviewSearchFilter
		INITIATOR_ROLE : String = "INITIATOR" [static] Specifies the initiator role.	ReviewSearchFilter
		MODERATOR_ROLE : String = "MODERATOR" [static] Specifies the moderator role.	ReviewSearchFilter
		REVIEWER_ROLE : String = "REVIEWER" [static] Specifies the reviewer role.	ReviewSearchFilter

Property Detail

customAttributes

property

customAttributes:Object

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies a map of custom attributes.

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

Related API Elements

CustomAttribute

endDate

property

endDate:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the 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 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies keywords in the review title or purpose 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 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the 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 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies a page number. Used when the results need to be 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 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies a page size. Used when 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 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies constraints for the results by user and role. For example, to show results only where the user is the approver.

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 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies whether to search reviews that are assigned to groups that the user belongs to.

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 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the start date of the review.

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

statusFilterList

property

statusFilterList:Array

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies a list of review status types to retrieve.

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

Related API Elements

com.adobe.livecycle.rca.model.constant.ReviewStatus

templateName

property

templateName:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the name of the template that is used to create 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 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the Object Identifier of the user who is performing the search.

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

Constructor Detail

ReviewSearchFilter

()

Constructor

public function ReviewSearchFilter()

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Filter class that is used to search review templates when using the searchReviews API.

Related API Elements

com.adobe.livecycle.rca.service.core.IReviewCommentingAndApprovalService

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

event:Event — The event object dispatched into the event flow.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

willTrigger

()

method

public function willTrigger(type:String):Boolean

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Constant Detail

APPROVER_ROLE

Constant

public static const APPROVER_ROLE:String = "APPROVER"

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the approver role.

INITIATOR_ROLE

Constant

public static const INITIATOR_ROLE:String = "INITIATOR"

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the initiator role.

MODERATOR_ROLE

Constant

public static const MODERATOR_ROLE:String = "MODERATOR"

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the moderator role.

REVIEWER_ROLE

Constant

public static const REVIEWER_ROLE:String = "REVIEWER"

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 9.5

Runtime Versions:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the reviewer role.

Legal Notices | Online Privacy Policy

ReviewSearchFilter - AS3 Review, Commenting, and Approval

Classes x

customAttributes

endDate

keywords

name

pageNumber

pageSize

role

searchGroupBasedReviews

startDate

statusFilterList

templateName

umOid

ReviewSearchFilter

addEventListener

dispatchEvent

hasEventListener

removeEventListener

willTrigger

APPROVER_ROLE

INITIATOR_ROLE

MODERATOR_ROLE

REVIEWER_ROLE