Packagelc.domain
Classpublic class SearchTemplate
InheritanceSearchTemplate Inheritance Object
Implements IWorkspaceManaged

The SearchTemplate class provides support for working with search templates.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  session : SessionMap
[read-only] A SessionMap object that stores information relating to the server session.
SearchTemplate
  template : XML
The XML that describes the search template.
SearchTemplate
Public Methods
 MethodDefined By
  
getSearchResults(searchFilter:SearchFilter):CollectionToken
Executes the search operation and retrieves the results.
SearchTemplate
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
setSession(session:SessionMap):void
Sets the SessionMap object that stores information relating to the server session.
SearchTemplate
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
sessionproperty
session:SessionMap  [read-only]

A SessionMap object that stores information relating to the server session.


Implementation
    public function get session():SessionMap
templateproperty 
template:XML  [read-write]

The XML that describes the search template.


Implementation
    public function get template():XML
    public function set template(value:XML):void
Method Detail
getSearchResults()method
public function getSearchResults(searchFilter:SearchFilter):CollectionToken

Executes the search operation and retrieves the results.

Parameters

searchFilter:SearchFilter — Specifies the search filter to use.

Returns
CollectionToken — A collection of results matching the search.
setSession()method 
public function setSession(session:SessionMap):void

Sets the SessionMap object that stores information relating to the server session.

Parameters

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




© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Sun Sep 23 2007, 10:15 PM GMT-07:00

 

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/SearchTemplate.html