Packagelc.domain
Classpublic class SearchFilter
InheritanceSearchFilter Inheritance Object
Implements IWorkspaceManaged

The SearchFilter class is used for specifying filtering conditions and retrieving search results.



Public Properties
 PropertyDefined By
  conditions : ArrayCollection
The collection of conditions of the search filter.
SearchFilter
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  outputs : ArrayCollection
The collection of outputs for a search filter.
SearchFilter
  processName : String
The process name for the search filter.
SearchFilter
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  searchType : String
The search type for the search filter.
SearchFilter
  session : SessionMap
[read-only] The SessionMap object of the search filter.
SearchFilter
  sorts : ArrayCollection
A collection of sorts for the search filter.
SearchFilter
  templateName : String
The template name of the search filter.
SearchFilter
Public Methods
 MethodDefined By
  
Executes the search request and returns a collection of tasks.
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
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
Specifies the SessionMap object for the class.
SearchFilter
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail
conditionsproperty
conditions:ArrayCollection  [read-write]

The collection of conditions of the search filter.


Implementation
    public function get conditions():ArrayCollection
    public function set conditions(value:ArrayCollection):void
outputsproperty 
outputs:ArrayCollection  [read-write]

The collection of outputs for a search filter.


Implementation
    public function get outputs():ArrayCollection
    public function set outputs(value:ArrayCollection):void
processNameproperty 
processName:String  [read-write]

The process name for the search filter.


Implementation
    public function get processName():String
    public function set processName(value:String):void
searchTypeproperty 
searchType:String  [read-write]

The search type for the search filter.


Implementation
    public function get searchType():String
    public function set searchType(value:String):void
sessionproperty 
session:SessionMap  [read-only]

The SessionMap object of the search filter.


Implementation
    public function get session():SessionMap
sortsproperty 
sorts:ArrayCollection  [read-write]

A collection of sorts for the search filter.


Implementation
    public function get sorts():ArrayCollection
    public function set sorts(value:ArrayCollection):void
templateNameproperty 
templateName:String  [read-write]

The template name of the search filter.


Implementation
    public function get templateName():String
    public function set templateName(value:String):void
Method Detail
getSearchResults()method
public function getSearchResults(session:SessionMap):CollectionToken

Executes the search request and returns a collection of tasks.

Parameters

session:SessionMap — Specifies the information relating to the server session.

Returns
CollectionToken — A collection of tasks that match the search request.
setSession()method 
public function setSession(session:SessionMap):void

Specifies the SessionMap object for the class.

Parameters

session:SessionMap — Specifies the information relating to the server session.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/domain/SearchFilter.html