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 

ISearchProvider  - AS3 Asset Manager
Packagecom.adobe.livecycle.assetmanager.client
Interfacepublic interface ISearchProvider extends IEventDispatcher
Implementors SearchManager
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

Enables an application to provide its own search implementation.


Public Properties
 PropertyDefined By
  lastQuery : SearchQuery
[read-only] Returns the search query associated with the result of the last search.
ISearchProvider
  lastResult : ListCollectionView
[read-only] Returns the result of the last search.
ISearchProvider
Public Methods
 MethodDefined By
 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.
IEventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
IEventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
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.
ISearchProvider
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
search(query:SearchQuery, resultsListView:ListCollectionView = null):void
Searches assets based on the specified search query.
ISearchProvider
 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.
IEventDispatcher
Events
Click for more information on events
 Event Summary Defined By
  
searchComplete
Thrown when SearchManager has completed searching.ISearchProvider
  
searchError
Thrown when SearchManager encounters an error during search.ISearchProvider
Property Detail

lastQuery

property
lastQuery:SearchQuery  [read-only]

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.



Implementation
    public function get lastQuery():SearchQuery

lastResult

property 
lastResult:ListCollectionView  [read-only]

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.



Implementation
    public function get lastResult():ListCollectionView
Method Detail

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.

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.




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

 

Legal Notices | Online Privacy Policy