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.interfaces 

ICatalog  - AS3 ADEP Composite Application
Packagecom.adobe.mosaic.om.interfaces
Interfacepublic interface ICatalog

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: AIR 2.6, Flash Player 10.2

The ICatalog interface represents a particular catalog, and provides methods for retrieving tiles from a catalog deployed to the Experience Server.


Public Properties
 PropertyDefined By
  panels : Array
[read-only] Retrieves an array of panels from the catalog to add to an application.
ICatalog
  serviceLibraries : Array
[read-only] Retrieves an array of service libraries from the catalog to add to an application.
ICatalog
  session : ISession
[read-only] Returns the current ISession associated with this catalog
ICatalog
  stylesheets : Array
[read-only] Returns an array of URLs representing each stylesheet from the composite application catalog.
ICatalog
  tiles : Array
[read-only] Retrieves an array of tiles from the catalog to add to an application.
ICatalog
  uri : String
[read-only] Returns the URI of this catalog, which is defined in the application(s) that reference this catalog.
ICatalog
  url : String
[read-only] Returns the current url for this catalog's descriptor
ICatalog
  views : Array
[read-only] Retrieves an array of views from the catalog to add to an application.
ICatalog
Public Methods
 MethodDefined By
  
getPanel(n:String):IPanel
Returns the panel with the given name from this Catalog.
ICatalog
  
getService(name:String, library:String):IService
Retrieves a service from the Service Library in the catalog.
ICatalog
  
getTile(n:String):com.adobe.mosaic.om.interfaces:ITile
Retrieves a tile from the catalog to add to an application.
ICatalog
  
getView(n:String):IView
Returns the view with the given name from this Catalog.
ICatalog
  
loadAsset(assetUri:String, onSuccess:Function = null, onFailure:Function = null):void
NOT IMPLEMENTED Retrieves any file asset from the catalog.
ICatalog
  
postAsset(assetUri:String, content:Object, onSuccess:Function = null, onFailure:Function = null):void
NOT IMPLEMENTED Sets any file asset in the catalog
ICatalog
Property Detail

panels

property
panels: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

Retrieves an array of panels from the catalog to add to an application. This method sets all the default parameters required for the panel to function.



Implementation
    public function get panels():Array

Related API Elements

com.adobe.mosaic.om.interfaces.IPanel

serviceLibraries

property 
serviceLibraries: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

Retrieves an array of service libraries from the catalog to add to an application.



Implementation
    public function get serviceLibraries():Array

Related API Elements

com.adobe.mosaic.om.interfaces.IServiceLibrary

session

property 
session:ISession  [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 current ISession associated with this catalog



Implementation
    public function get session():ISession

Related API Elements

com.adobe.mosaic.om.interfaces.ISession

stylesheets

property 
stylesheets: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

Returns an array of URLs representing each stylesheet from the composite application catalog.

The stylesheets can be referenced by tiles to allow you to create consistent styling between tiles and the containing applications.



Implementation
    public function get stylesheets():Array

Related API Elements

mx.styles.StyleManager

tiles

property 
tiles: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

Retrieves an array of tiles from the catalog to add to an application. This method sets all the default parameters required for the tile to function.



Implementation
    public function get tiles():Array

Related API Elements

com.adobe.mosaic.om.interfaces.ITile

uri

property 
uri:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: AIR 2.6, Flash Player 10.2

Returns the URI of this catalog, which is defined in the application(s) that reference this catalog.



Implementation
    public function get uri():String

url

property 
url: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

Returns the current url for this catalog's descriptor



Implementation
    public function get url():String

views

property 
views: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

Retrieves an array of views from the catalog to add to an application. This method sets all the default parameters required for the view to function.



Implementation
    public function get views():Array

Related API Elements

com.adobe.mosaic.om.interfaces.IView
Method Detail

getPanel

()method
public function getPanel(n:String):IPanel

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: AIR 2.6, Flash Player 10.2

Returns the panel with the given name from this Catalog.

Parameters

n:String — The name of the panel in the catalog. This corresponds to the name attribute in the deployed catalog.

Returns
IPanel — The named Panel from the Catalog

getService

()method 
public function getService(name:String, library:String):IService

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: AIR 2.6, Flash Player 10.2

Retrieves a service from the Service Library in the catalog.

Parameters

name:String — The name of the service class
 
library:String — The service library name that holds the service class

Returns
IService — The Service stored in the catalog

Related API Elements

com.adobe.mosaic.om.interfaces.IService

getTile

()method 
public function getTile(n:String):com.adobe.mosaic.om.interfaces:ITile

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: AIR 2.6, Flash Player 10.2

Retrieves a tile from the catalog to add to an application. This method sets all the default parameters required for the tile to function.

Parameters

n:String — The name of the tile in the catalog. This corresponds to the name attribute in the deployed catalog.

Returns
com.adobe.mosaic.om.interfaces:ITile — The tile that implements ITile.

Related API Elements

com.adobe.mosaic.om.interfaces.ITile

Example
How to use this example
This example retrieves a tile named "sampleTile" from the catalog "sample_catalog", and adds the tile to the current panel: 
		 var c:ICatalog = mosaicApp.getCatalog("sample_catalog");
		 var t:ITile = c.getTile("sampleTile");
		 this.parentPanel.addTile(t);

getView

()method 
public function getView(n:String):IView

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: AIR 2.6, Flash Player 10.2

Returns the view with the given name from this Catalog.

Parameters

n:String — The name of the view in the catalog. This corresponds to the name attribute in the deployed catalog.

Returns
IView — The named View from the Catalog

loadAsset

()method 
public function loadAsset(assetUri:String, onSuccess:Function = null, onFailure:Function = null):void

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

NOT IMPLEMENTED Retrieves any file asset from the catalog.

Parameters

assetUri:String — uri of the asset relative to the /content/mosaic/catalog
 
onSuccess:Function (default = null) — callback if the request is successful. It will have AssetLoadEvent containing data.
 
onFailure:Function (default = null) — callback if the request fails

postAsset

()method 
public function postAsset(assetUri:String, content:Object, onSuccess:Function = null, onFailure:Function = null):void

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

NOT IMPLEMENTED Sets any file asset in the catalog

Parameters

assetUri:String — uri of the asset relative to the /content/mosaic/catalog
 
content:Object — Object containing the data to post/set
 
onSuccess:Function (default = null) — callback if the request is successful
 
onFailure:Function (default = null) — callback if the request fails



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

 

Legal Notices | Online Privacy Policy