| Package | com.adobe.ep.ux.content.managers |
| Interface | public 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) |
ISearchProvider interface implements a custom search implementation.
Public Properties
| Property | Defined 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
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
 | 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 | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
|
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 | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Searches the Assets based on given searchQuery. | ISearchProvider | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| The searchComplete event is thrown when a search completes successfully. | ISearchProvider | |||
| 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():SearchQuerylastResult | 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():ListCollectionViewMethod 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) |
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.
Mon Nov 28 2011, 06:48 AM -08:00