| Package | com.adobe.icc.editors.managers |
| Class | public class ContentSearchManager |
| Inheritance | ContentSearchManager  EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
ContentSearchManager lets you search for content in the system by name.
ContentSearchManager abstracts the query required to search for data modules
by their name. This can be used for simple and frequent content searches. In case, a more complex
search is required, the search APIs and the associated Query objects must be used instead.
Similar to flex's HTTPService, this class has a lastResult bindable property which
can be conveniently used to display the result of the last search made on the UI.
Related API Elements
com.adobe.livecycle.assetmanager.client.service.search.cms.ICMSQueryService
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 | |
| lastResult : ListCollectionView
The list of ModuleModel objects reflecting the result of the last search query executed. | ContentSearchManager | ||
| lastSearchString : String
The last query string that was used to invoke search on ContentSearchManager. | ContentSearchManager | ||
| 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. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
Re-executes the last search in order to refresh the results. | ContentSearchManager | ||
|
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 | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
Searches the server for asset matching the passed name. | ContentSearchManager | ||
|
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 | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when a search invoked on the ContentSearchManager completes successfully. | ContentSearchManager | |||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a search invoked on the ContentSearchManager fails. | ContentSearchManager | |||
lastResult | property |
public var lastResult:ListCollectionView| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The list of ModuleModel objects reflecting the result of the last search query executed.
The list holds objects of type ModuleModel which is a super class representing
the various modules in the system viz. Texts, Images, Lists and Conditions.
This property can be used as the source for data binding. When this property is modified, it dispatches the complete event.
lastSearchString | property |
lastSearchString:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The last query string that was used to invoke search on ContentSearchManager.
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 lastSearchString():String public function set lastSearchString(value:String):voidexecuteLastSearch | () | method |
public function executeLastSearch():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Re-executes the last search in order to refresh the results.
search | () | method |
public function search(searchString:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Searches the server for asset matching the passed name. The type of asset searched for includes Texts, Images, Lists and Conditions.
By default, the search mode is "like", wherein all assets with names containing the search string are returned. An "exact" search can however be invoked by including the search param within quotes e.g. "myasset01"
Parameters
searchString:String — The name (or part of it) of the asset that needs to be searched.
Could be null or empty which amounts to retrieving everything as search result.
|
complete | Event |
flash.events.Eventproperty Event.type =
flash.events.Event| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Dispatched when a search invoked on the ContentSearchManager
completes successfully.
This event is dispatched in an asynchronous manner when the server responds
for the search requested via the ContentSearchManager successfully.
fault | Event |
mx.rpc.events.FaultEventproperty FaultEvent.type =
mx.rpc.events.FaultEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Dispatched when a search invoked on the ContentSearchManager
fails.
This event is dispatched in an asynchronous manner when the server errors out
for the search requested via the ContentSearchManager.
Mon Apr 10 2017, 12:28 PM -07:00