| Package | com.adobe.mosaic.om.events |
| Class | public class SearchCatalogEvent |
| Inheritance | SearchCatalogEvent  BaseEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
SearchCatalogEvent class defines a transient notification of catalog search results.
SearchCatalogEvent objects are not retained or stored after all their listeners have been processed.
SearchCatalogEvent objects are used to communicate information and do not need to be
persisted or referenced.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| catalog : ICatalog [read-only]
Returns the catalog node that was found. | SearchCatalogEvent | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| message : String [read-only]
Returns a message string. | BaseEvent | |
| NAMESPACE : String [static] [read-only]
The namespace for messages of this type. | SearchCatalogEvent | ||
| object : * [read-only]
Returns the node that was added. | BaseEvent | |
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | SearchCatalogEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| FAILURE : String = "searchCatalogEventFailure" [static]
The namespace for messages of this type. | SearchCatalogEvent | ||
| SUCCESS : String = "searchCatalogEventSuccess" [static]
The message type sent when a the requested assets from a catalog are found. | SearchCatalogEvent | ||
Property Detail
catalog | property |
catalog:ICatalog [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns the catalog node that was found. It returns the partial catalog containing only assets which match the query criteria passed in on the searchCatalog API.
Implementation
public function get catalog():ICatalogRelated API Elements
NAMESPACE | property |
NAMESPACE:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The namespace for messages of this type.
Implementation
public static function get NAMESPACE():StringConstructor Detail
SearchCatalogEvent | () | Constructor |
public function SearchCatalogEvent(type:String, catalog:ICatalog, errMsg:String)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Constructor.
Parameterstype:String — Event type
| |
catalog:ICatalog — Event ICatalog
| |
errMsg:String — Event error message
|
Related API Elements
Constant Detail
FAILURE | Constant |
public static const FAILURE:String = "searchCatalogEventFailure"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The namespace for messages of this type.
SUCCESS | Constant |
public static const SUCCESS:String = "searchCatalogEventSuccess"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The message type sent when a the requested assets from a catalog are found. This can occur through API calls.
Mon Apr 10 2017, 12:28 PM -07:00