ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.mosaic.om.events 

RequestCatalogListEvent  - AS3 NOT

Packagecom.adobe.mosaic.om.events
Classpublic class RequestCatalogListEvent
InheritanceRequestCatalogListEvent Inheritance BaseEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: NOT IMPLEMENTED
Runtime Versions: AIR 2.6, Flash Player 10.2

NOT IMPLEMENTED The RequestCatalogListEvent class defines a transient notification of an array of type ICatalogListItem representing the catalogs available to the current user.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
  catalogList : Array
[read-only] An array of type ICatalogListItem representing the catalogs available to the current user.
RequestCatalogListEvent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedmessage : String
[read-only] Returns a message string.
BaseEvent
  NAMESPACE : String
[static] [read-only] The namespace for messages of this type.
RequestCatalogListEvent
 Inheritedobject : *
[read-only] Returns the node that was added.
BaseEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
RequestCatalogListEvent(type:String, catList:Array = null, msg:String = null)
Constructor.
RequestCatalogListEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  FAILURE : String = "requestCatalogListEventFailure"
[static] This type is sent when handling failed in retrieving an array of type ICatalogListItem representing the catalogs available to the current user
RequestCatalogListEvent
  SUCCESS : String = "requestCatalogListEventSuccess"
[static] This type is sent when handling succeeded in retrieving an array of type ICatalogListItem representing the catalogs available to the current user
RequestCatalogListEvent
Property Detail

catalogList

property
catalogList:Array  [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

An array of type ICatalogListItem representing the catalogs available to the current user.



Implementation
    public function get catalogList():Array

Related 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():String
Constructor Detail

RequestCatalogListEvent

()Constructor
public function RequestCatalogListEvent(type:String, catList:Array = null, msg:String = null)

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.

Parameters
type:String — - String
 
catList:Array (default = null) — - Array of type ICatalogListItem representing the catalogs available to the current user.
 
msg:String (default = null) — - String

Related API Elements

Constant Detail

FAILURE

Constant
public static const FAILURE:String = "requestCatalogListEventFailure"

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

This type is sent when handling failed in retrieving an array of type ICatalogListItem representing the catalogs available to the current user

SUCCESS

Constant 
public static const SUCCESS:String = "requestCatalogListEventSuccess"

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

This type is sent when handling succeeded in retrieving an array of type ICatalogListItem representing the catalogs available to the current user