| Package | com.adobe.livecycle.assetmanager.client.managers |
| Class | public class SearchManager |
| Inheritance | SearchManager  EventDispatcher Object |
| Implements | IResponder, ISearchProvider |
Deprecated: Deprecated
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Public Properties
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 | |
| lastQuery : SearchQuery
Returns the search query associated with the result of the last search. | SearchManager | ||
| lastResult : ListCollectionView
Returns the result of the last search. | SearchManager | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| queryType : String = "HQLQuery" [static]
Specifies the query type to use when IQueryService is called. | SearchManager | ||
| showBusyCursor : Boolean
Specifies whether to display a busy cursor while a search is in progress. | SearchManager | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | SearchManager | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
This method is called by a service when an error has been received. | SearchManager | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
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 | |
releaseSearchResults(resultsListView:ListCollectionView, assetDescriptor:com.adobe.livecycle.assetmanager.client.model:AssetTypeDescriptor):void
Releases the search results and does any clean up tasks that are required. | SearchManager | ||
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
This method is called by a service when the return value
has been received. | SearchManager | ||
Searches assets based on the specified search query. | SearchManager | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
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. | EventDispatcher | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Thrown when SearchManager has completed searching. | SearchManager | |||
| Thrown when SearchManager encounters an error during search. | SearchManager | |||
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| CMS_QUERY_TYPE : String = "CMSQuery" [static]
Specifies the query type to use when IQueryService is called. | SearchManager | ||
Property Detail
lastQuery | property |
lastQuery:SearchQuery| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns the search query associated with the result of the last search. This function is updated when the lastResults function is updated.
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 lastQuery():SearchQuery public function set lastQuery(value:SearchQuery):voidlastResult | property |
lastResult:ListCollectionView| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns the result of the last search.
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 lastResult():ListCollectionView public function set lastResult(value:ListCollectionView):voidqueryType | property |
public static var queryType:String = "HQLQuery"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the query type to use when IQueryService is called.
showBusyCursor | property |
showBusyCursor:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies whether to display a busy cursor while a search is in progress.
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 showBusyCursor():Boolean public function set showBusyCursor(value:Boolean):voidConstructor Detail
SearchManager | () | Constructor |
public function SearchManager()| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
Method Detail
fault | () | method |
public function fault(info:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
This method is called by a service when an error has been received.
While info is typed as Object it is often
(but not always) an mx.rpc.events.FaultEvent.
Parameters
info:Object |
releaseSearchResults | () | method |
public function releaseSearchResults(resultsListView:ListCollectionView, assetDescriptor:com.adobe.livecycle.assetmanager.client.model:AssetTypeDescriptor):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Releases the search results and does any clean up tasks that are required. For example, disabling automatic synchronization provided by the Data Management Service.
Parameters
resultsListView:ListCollectionView — Search results to release.
| |
assetDescriptor:com.adobe.livecycle.assetmanager.client.model:AssetTypeDescriptor — AssetTypeDescriptor of the current asset, listed in the results grid.
|
result | () | method |
public function result(data:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
This method is called by a service when the return value
has been received.
While data is typed as Object, it is often
(but not always) an mx.rpc.events.ResultEvent.
Parameters
data:Object |
search | () | method |
public function search(query:SearchQuery, resultsListView:ListCollectionView = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Searches assets based on the specified search query.
Parameters
query:SearchQuery — A SearchQuery object.
| |
resultsListView:ListCollectionView (default = null) |
Event Detail
searchComplete | Event |
Event Object Type:
com.adobe.livecycle.assetmanager.client.event.SearchEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Thrown when SearchManager has completed searching.
searchError | Event |
Event Object Type:
mx.rpc.events.FaultEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Thrown when SearchManager encounters an error during search.
Constant Detail
CMS_QUERY_TYPE | Constant |
public static const CMS_QUERY_TYPE:String = "CMSQuery"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the query type to use when IQueryService is called.
Mon Nov 28 2011, 06:48 AM -08:00