| Package | lc.procmgmt.domain |
| Class | public class SearchTemplateDescriptor |
| Inheritance | SearchTemplateDescriptor  Object |
| Implements | IManagedObject, IManaged |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : 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 | ||
| 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 | ||
| Method | Defined By | ||
|---|---|---|---|
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. | SearchTemplateDescriptor | ||
Dispatches an event into the event flow. | SearchTemplateDescriptor | ||
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 | ||
Retrieves a search template based on the current ID. | SearchTemplateDescriptor | ||
Retrieves a list of the search templates. | SearchTemplateDescriptor | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | SearchTemplateDescriptor | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
Removes a listener from the EventDispatcher object. | SearchTemplateDescriptor | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
Sets a SessionMap object that stores the information relating to the
server session. | SearchTemplateDescriptor | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
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. | SearchTemplateDescriptor | ||
description | property |
description:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The description for a search template descriptor that is provided by the template creator.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get description():String public function set description(value:String):voidid | property |
id:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The unique identifier of the search template descriptor.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get id():Number public function set id(value:Number):voidname | property |
name:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The name of the search template descriptor that is provided by the template creator.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get name():String public function set name(value:String):voidservice | property |
service:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The service name associated with the search template descriptor.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get service():String public function set service(value:String):voidsession | property |
session:SessionMap [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A SessionMap object that stores information relating to the server session.
Implementation
public function get session():SessionMapRelated API Elements
addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):voidRegisters 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:
| |
useCapture:Boolean (default = false)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) | |
weakRef:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
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.
|
Boolean — A value of true unless preventDefault() is called on the event,
in which case it returns false.
|
getSearchFilter | () | method |
public function getSearchFilter():SearchFilter| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves and populates a SearchFilter object based on the current name.
SearchFilter — A search filter based on the current name of the search filter
descriptor.
|
Related API Elements
getSearchFilterAttribute | () | method |
public function getSearchFilterAttribute(attrScope:String, attrName:String, attrType:String, attrTitle:String = null):SearchFilterAttribute| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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) |
SearchFilterAttribute — The search filter attribute based on the provided parameters.
|
Related API Elements
getSearchFilterCondition | () | method |
public function getSearchFilterCondition(attribute:SearchFilterAttribute, operator:String, value1:String, value2:String = null):SearchFilterCondition| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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) |
SearchFilterCondition — The search filter condition.
|
Related API Elements
getSearchFilterSort | () | method |
public function getSearchFilterSort(attribute:SearchFilterAttribute, precedence:int, direction:String):SearchFilterSort| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
|
SearchFilterSort — A search filter sort.
|
Related API Elements
getSearchTemplate | () | method |
public function getSearchTemplate():lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a search template based on the current ID.
Returnslc.foundation.util:ObjectToken — A search template.
|
getSearchTemplateDescriptors | () | method |
public function getSearchTemplateDescriptors():lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a list of the search templates.
Returnslc.foundation.util:CollectionToken — A collection of search templates.
|
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.
|
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):voidRemoves 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)removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.
|
setSession | () | method |
public function setSession(session:SessionMap):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets a SessionMap object that stores the information relating to the
server session.
Parameters
session:SessionMap — Specifies the information relating to the server session.
|
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.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Mon Apr 10 2017, 12:28 PM -07:00