ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.livecycle.assetmanager.client.managers 

SearchManager  - AS3 Asset Manager
Packagecom.adobe.livecycle.assetmanager.client.managers
Classpublic class SearchManager
InheritanceSearchManager Inheritance EventDispatcher Inheritance 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

Used to search assets.


Public Properties
 PropertyDefined By
 Inheritedconstructor : 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
  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
 MethodDefined By
  
SearchManager()
Constructor.
SearchManager
 Inherited
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
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
fault(info:Object):void
This method is called by a service when an error has been received.
SearchManager
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 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
  
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
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
result(data:Object):void
This method is called by a service when the return value has been received.
SearchManager
  
search(query:SearchQuery, resultsListView:ListCollectionView = null):void
Searches assets based on the specified search query.
SearchManager
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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.
EventDispatcher
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  
searchComplete
Thrown when SearchManager has completed searching.SearchManager
  
searchError
Thrown when SearchManager encounters an error during search.SearchManager
Public Constants
 ConstantDefined 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):void

lastResult

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):void

queryType

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):void
Constructor 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) — The results collection to populate.
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.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy