Packagelc.domain
Classpublic class SearchTemplateDescriptor
InheritanceSearchTemplateDescriptor Inheritance Object
Implements IWorkspaceManaged

The SearchTemplateDescriptor class is used for working with the search template descriptor. Search template descriptors are composed of a unique identifer, a name, a description, the service that is associated with a service, and the template to use for searching. The template is stored as XML.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  description : String
The description for a search template descriptor that is provided by the template creator.
SearchTemplateDescriptor
  id : Number
The unique identifier of the search template descriptor.
SearchTemplateDescriptor
  name : String
The name of the search template descriptor that is provided by the template creator.
SearchTemplateDescriptor
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  service : String
The service name associated with the search template descriptor.
SearchTemplateDescriptor
  session : SessionMap
[read-only] A SessionMap object that stores information relating to the server session.
SearchTemplateDescriptor
Public Methods
 MethodDefined By
  
getSearchFilter():SearchFilter
Retrieves and populates a SearchFilter object based on the current name.
SearchTemplateDescriptor
  
getSearchFilterAttribute(attrScope:String, attrName:String, attrType:String, attrTitle:String = null):SearchFilterAttribute
Retrieves and populates a SearchFieldAttribute object.
SearchTemplateDescriptor
  
getSearchFilterCondition(attribute:SearchFilterAttribute, operator:String, value1:String, value2:String = null):SearchFilterCondition
Retrieves and populates a SearchFieldCondition object.
SearchTemplateDescriptor
  
getSearchFilterSort(attribute:SearchFilterAttribute, precedence:int, direction:String):SearchFilterSort
Retrieves and populates a SearchFieldSort object.
SearchTemplateDescriptor
  
getSearchTemplate():ObjectToken
Retrieves a search template based on the current ID.
SearchTemplateDescriptor
  
getSearchTemplateDescriptors():CollectionToken
Retrieves a list of the search templates.
SearchTemplateDescriptor
 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 a SessionMap object that stores the information relating to the server session.
SearchTemplateDescriptor
 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
descriptionproperty
description:String  [read-write]

The description for a search template descriptor that is provided by the template creator.


Implementation
    public function get description():String
    public function set description(value:String):void
idproperty 
id:Number  [read-write]

The unique identifier of the search template descriptor.


Implementation
    public function get id():Number
    public function set id(value:Number):void
nameproperty 
name:String  [read-write]

The name of the search template descriptor that is provided by the template creator.


Implementation
    public function get name():String
    public function set name(value:String):void
serviceproperty 
service:String  [read-write]

The service name associated with the search template descriptor.


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

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


Implementation
    public function get session():SessionMap

See also

lc.domain.SessionMap
Method Detail
getSearchFilter()method
public function getSearchFilter():SearchFilter

Retrieves and populates a SearchFilter object based on the current name.

Returns
SearchFilter — A search filter based on the current name of the search filter descriptor.

See also

lc.domain.SearchFilter
getSearchFilterAttribute()method 
public function getSearchFilterAttribute(attrScope:String, attrName:String, attrType:String, attrTitle:String = null):SearchFilterAttribute

Retrieves and populates a SearchFieldAttribute object.

Parameters

attrScope:String — Specifies the scope for the search filter.
 
attrName:String — Specifies the name of the search filter.
 
attrType:String — Specifies the type of the search filter.
 
attrTitle:String (default = null) — Specifies the title of the attribute.

Returns
SearchFilterAttribute — The search filter attribute based on the provided parameters.

See also

lc.domain.SearchFilterAttribute
getSearchFilterCondition()method 
public function getSearchFilterCondition(attribute:SearchFilterAttribute, operator:String, value1:String, value2:String = null):SearchFilterCondition

Retrieves and populates a SearchFieldCondition object.

Parameters

attribute:SearchFilterAttribute — Specifies the search filter attribute.
 
operator:String — Specifies the operators to use in the search.
 
value1:String — Specifies search field condition.
 
value2:String (default = null) — Specifies other search field conditions.

Returns
SearchFilterCondition — The search filter condition.

See also

lc.domain.SearchFilterCondition
getSearchFilterSort()method 
public function getSearchFilterSort(attribute:SearchFilterAttribute, precedence:int, direction:String):SearchFilterSort

Retrieves and populates a SearchFieldSort object.

Parameters

attribute:SearchFilterAttribute — Specifies the attributes for sorting search filters.
 
precedence:int — Specifies the order in which to sort search filters.
 
direction:String — Specifies whether the search results are ascending or descending.

Returns
SearchFilterSort — A search filter sort.

See also

lc.domain.SearchFilterSort
getSearchTemplate()method 
public function getSearchTemplate():ObjectToken

Retrieves a search template based on the current ID.

Returns
ObjectToken — A search template.
getSearchTemplateDescriptors()method 
public function getSearchTemplateDescriptors():CollectionToken

Retrieves a list of the search templates.

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

Sets a SessionMap object that stores the 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/SearchTemplateDescriptor.html