| Package | com.adobe.mosaic.om.interfaces |
| Interface | public 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 |
ICatalog interface represents a particular catalog, and provides methods for retrieving
tiles from a catalog deployed to the Experience Server.
| Property | Defined 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 | ||
| Method | Defined By | ||
|---|---|---|---|
Returns the panel with the given name from this Catalog. | ICatalog | ||
Retrieves a service from the Service Library in the catalog. | ICatalog | ||
Retrieves a tile from the catalog to add to an application. | ICatalog | ||
Returns the view with the given name from this Catalog. | ICatalog | ||
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 | ||
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():ArrayRelated API Elements
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():ArrayRelated API Elements
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():ISessionRelated API Elements
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():ArrayRelated API Elements
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():ArrayRelated API Elements
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():Stringurl | 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():Stringviews | 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():ArrayRelated API Elements
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.
|
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
|
IService — The Service stored in the catalog
|
Related API Elements
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.
|
com.adobe.mosaic.om.interfaces:ITile — The tile that implements ITile.
|
Related API Elements
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.
|
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) | |
onFailure:Function (default = null) |
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) | |
onFailure:Function (default = null) |
Mon Nov 28 2011, 06:48 AM -08:00