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

ISearchProvider  - AS3 ADEP Content
Packagecom.adobe.ep.ux.content.managers
Interfacepublic interface ISearchProvider extends IEventDispatcher

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The ISearchProvider interface implements a custom search implementation.


Public Properties
 PropertyDefined By
  lastQuery : SearchQuery
[read-only] The searchQuery associated with lastResults.
ISearchProvider
  lastResult : ListCollectionView
[read-only] The results fetched from 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.ep.ux.content.model.asset:AssetTypeDescriptor):void
Releases the search results and performs any cleanup 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 the Assets based on given searchQuery.
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
The searchComplete event is thrown when a search completes successfully.ISearchProvider
  
searchError
The searchError event is thrown when an error occurs during a search.ISearchProvider
Property Detail

lastQuery

property
lastQuery:SearchQuery  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The searchQuery associated with lastResults. This value is updated at the same time when the lastResults property is updated.



Implementation
    public function get lastQuery():SearchQuery

lastResult

property 
lastResult:ListCollectionView  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The results fetched from the last search.



Implementation
    public function get lastResult():ListCollectionView
Method Detail

releaseSearchResults

()method
public function releaseSearchResults(resultsListView:ListCollectionView, assetDescriptor:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Releases the search results and performs any cleanup required. For example, unmanage the results from Data Management Services auto synchronization.

Parameters

resultsListView:ListCollectionView — Specifies the results collection handle to be released.
 
assetDescriptor:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor — Specifies the asset for which results are to be released.

search

()method 
public function search(query:SearchQuery, resultsListView:ListCollectionView = null):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Searches the Assets based on given searchQuery.

Parameters

query:SearchQuery — Specifies the search query to execute.
 
resultsListView:ListCollectionView (default = null) — Specifies the result collection for a search.
Event Detail

searchComplete

 Event
Event Object Type: com.adobe.ep.ux.content.event.SearchEvent

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The searchComplete event is thrown when a search completes successfully.

searchError

 Event  
Event Object Type: mx.rpc.events.FaultEvent

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The searchError event is thrown when an error occurs during a search.




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

 

Legal Notices | Online Privacy Policy