ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.ep.ux.content.model.search 

SearchFilter  - AS3 ADEP Content

Packagecom.adobe.ep.ux.content.model.search
Classpublic class SearchFilter
InheritanceSearchFilter Inheritance Object
Implements IEventDispatcher

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This class represents the search criteria for the search on an Asset. Each search renderer will have it's own instance of SearchFilter.



Public Properties
 PropertyDefined By
  attributeName : String
Name of the attribute on which the search has to be performed.
SearchFilter
  attributeValue : *
Attribute value for the filter.
SearchFilter
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  innerJoinOperator : int
Operator used to join this searchfilter with it's nested innerSearchFilters
SearchFilter
  innerSearchFilters : IList
Nested list of search filters which will be inner-joined (using innerJoinOperator) to the parent searchfilter (this).
SearchFilter
  operator : int
Operator for establishing search type relation between attributeName and attributeValue for e.g.
SearchFilter
  outerJoinOperator : int
Operator to outer-join this search filter with other search filters which are at the same level in search filter list
SearchFilter
Public Methods
 MethodDefined By
  
Constructor.
SearchFilter
  
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.
SearchFilter
  
Dispatches an event into the event flow.
SearchFilter
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
SearchFilter
 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
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
SearchFilter
  
Reset the filter state to original state(when filter is created)
SearchFilter
 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
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
SearchFilter
Public Constants
 ConstantDefined By
  JOIN_OPERATOR_AND : int = 0
[static] This special value represents the JOIN operator AND.
SearchFilter
  JOIN_OPERATOR_AND_NOT : int = 2
[static] This special value represents the JOIN operator AND_NOT
SearchFilter
  JOIN_OPERATOR_OR : int = 1
[static] This special value represents the JOIN operator OR.
SearchFilter
  JOIN_OPERATOR_OR_NOT : int = 3
[static] This special value represents the JOIN operator OR_NOT
SearchFilter
  OPERATOR_CONTAINS : int = 8
[static] This special value represents the CONTAINS operator.
SearchFilter
  OPERATOR_ENDS_WITH : int = 7
[static] This special value represents the ENDS WITH operator.
SearchFilter
  OPERATOR_EQUALS : int = 0
[static] This special value represents the EQUALS operator.
SearchFilter
  OPERATOR_FULL_TEXT_SEARCH : int = 10
[static] This special value represents the FULL TEXT SEARCH operator.
SearchFilter
  OPERATOR_FULL_TEXT_SEARCH_ON_PROPERTIES : int = 13
[static] This special value represents the FULL TEXT SEARCH operator.
SearchFilter
  OPERATOR_GREATER_THAN : int = 3
[static] This special value represents the GREATER THAN operator.
SearchFilter
  OPERATOR_GREATER_THAN_EQUALS : int = 5
[static] This special value represents the GREATER THAN OR EQUALS TO operator.
SearchFilter
  OPERATOR_LESS_THAN : int = 2
[static] This special value represents the LESS THAN operator.
SearchFilter
  OPERATOR_LESS_THAN_EQUALS : int = 4
[static] This special value represents the LESS THAN OR EQUALS TO operator.
SearchFilter
  OPERATOR_LIKE : int = 9
[static] This special value represents the LIKE operator.
SearchFilter
  OPERATOR_NOT_EQUALS : int = 1
[static] This special value represents the NOT EQUALS operator.
SearchFilter
  OPERATOR_NOT_NULL : int = 12
[static] This special value represents the NOT NULL CHECK operator.
SearchFilter
  OPERATOR_NULL : int = 11
[static] This special value represents the NULL CHECK operator.
SearchFilter
  OPERATOR_STARTS_WITH : int = 6
[static] This special value represents the STARTS WITH operator.
SearchFilter
Property Detail

attributeName

property
attributeName:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Name of the attribute on which the search has to be performed. It has to be of form <Unqualified Entitity Name>.<fieldName> for e.g. Category.name . Search Renderer should pick this value from AssetPropertyDescriptor.searchPath attribute.



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

attributeValue

property 
attributeValue:*

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Attribute value for the filter.



Implementation
    public function get attributeValue():*
    public function set attributeValue(value:any):void

innerJoinOperator

property 
innerJoinOperator:int

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Operator used to join this searchfilter with it's nested innerSearchFilters



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

innerSearchFilters

property 
innerSearchFilters:IList

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Nested list of search filters which will be inner-joined (using innerJoinOperator) to the parent searchfilter (this).



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

operator

property 
operator:int

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Operator for establishing search type relation between attributeName and attributeValue for e.g. OPERATOR_GREATER_THAN



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

outerJoinOperator

property 
outerJoinOperator:int

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Operator to outer-join this search filter with other search filters which are at the same level in search filter list



Implementation
    public function get outerJoinOperator():int
    public function set outerJoinOperator(value:int):void
Constructor Detail

SearchFilter

()Constructor
public function SearchFilter()

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Constructor.

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.

resetFilter

()method 
public function resetFilter():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Reset the filter state to original state(when filter is created)

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.

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 will be triggered; false otherwise.
Constant Detail

JOIN_OPERATOR_AND

Constant
public static const JOIN_OPERATOR_AND:int = 0

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the JOIN operator AND. It is used to join two statements

JOIN_OPERATOR_AND_NOT

Constant 
public static const JOIN_OPERATOR_AND_NOT:int = 2

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the JOIN operator AND_NOT

JOIN_OPERATOR_OR

Constant 
public static const JOIN_OPERATOR_OR:int = 1

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the JOIN operator OR. It is used to join two statements

JOIN_OPERATOR_OR_NOT

Constant 
public static const JOIN_OPERATOR_OR_NOT:int = 3

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the JOIN operator OR_NOT

OPERATOR_CONTAINS

Constant 
public static const OPERATOR_CONTAINS:int = 8

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the CONTAINS operator. It is valid for text operands

OPERATOR_ENDS_WITH

Constant 
public static const OPERATOR_ENDS_WITH:int = 7

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the ENDS WITH operator. It is valid for text operands

OPERATOR_EQUALS

Constant 
public static const OPERATOR_EQUALS:int = 0

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the EQUALS operator. It is valid for all data types

OPERATOR_FULL_TEXT_SEARCH

Constant 
public static const OPERATOR_FULL_TEXT_SEARCH:int = 10

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the FULL TEXT SEARCH operator. It searches across all attributes of the entity

OPERATOR_FULL_TEXT_SEARCH_ON_PROPERTIES

Constant 
public static const OPERATOR_FULL_TEXT_SEARCH_ON_PROPERTIES:int = 13

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the FULL TEXT SEARCH operator. It searches across all attributes of the entity

OPERATOR_GREATER_THAN

Constant 
public static const OPERATOR_GREATER_THAN:int = 3

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the GREATER THAN operator. It is valid for numeral and date operands

OPERATOR_GREATER_THAN_EQUALS

Constant 
public static const OPERATOR_GREATER_THAN_EQUALS:int = 5

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the GREATER THAN OR EQUALS TO operator. It is valid for numeral and date operands

OPERATOR_LESS_THAN

Constant 
public static const OPERATOR_LESS_THAN:int = 2

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the LESS THAN operator. It is valid for numeral and date operands

OPERATOR_LESS_THAN_EQUALS

Constant 
public static const OPERATOR_LESS_THAN_EQUALS:int = 4

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the LESS THAN OR EQUALS TO operator. It is valid for numeral and date operands

OPERATOR_LIKE

Constant 
public static const OPERATOR_LIKE:int = 9

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the LIKE operator. It is valid for text wild characters

OPERATOR_NOT_EQUALS

Constant 
public static const OPERATOR_NOT_EQUALS:int = 1

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the NOT EQUALS operator. It is valid for all data types

OPERATOR_NOT_NULL

Constant 
public static const OPERATOR_NOT_NULL:int = 12

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the NOT NULL CHECK operator. The attribute value is ignored in this case.

OPERATOR_NULL

Constant 
public static const OPERATOR_NULL:int = 11

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the NULL CHECK operator. The attribute value is ignored in this case.

OPERATOR_STARTS_WITH

Constant 
public static const OPERATOR_STARTS_WITH:int = 6

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This special value represents the STARTS WITH operator. It is valid for text operands