| Package | com.adobe.icc.services.module |
| Interface | public interface IModuleService extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
activateDataModule(moduleId:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken
Activates the specified data module. | IModuleService | ||
 | 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. | IEventDispatcher | |
DESCRIPTION NEEDS REFINING! Duplicate a DataModule. | IModuleService | ||
Creats a new module and persists it. | IModuleService | ||
Creates a test version of the specified module. | IModuleService | ||
Determines if the specified data module exists. | IModuleService | ||
Deletes a data module
| IModuleService | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Returns a list of data modules based on a query. | IModuleService | ||
Retrieves a Data Module. | IModuleService | ||
Retrieves a Data Module By Version. | IModuleService | ||
getDependentLetterList(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
Retrieve a list of letters that depend on the specified module. | IModuleService | ||
Retrieve a direct list of letters that depend on the specified module. | IModuleService | ||
getDependentModuleList(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
Retrieve a list of modules that depend on the specified module. | IModuleService | ||
getDependentModules(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
Retrieve a list of modules that depend on the specified module. | IModuleService | ||
getUsedDataModules(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
Retrieve the list of other modules that is used by the module identified by the given moduleID. | IModuleService | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Determine if the specified module is reference by some other asset (e.g. | IModuleService | ||
Marks for Publish an existing module in the database. | IModuleService | ||
Publishes an existing module in the database. | IModuleService | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Reverts the data module to the last published version. | IModuleService | ||
Update an existing module in the database. | IModuleService | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
activateDataModule | () | method |
public function activateDataModule(moduleId:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Activates the specified data module.
Parameters
moduleId:String — ID (GUID) of the module.
| |
updateDependencies:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — The activated DataModule object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
copyDataModule | () | method |
public function copyDataModule(srcModuleId:String, newModule:DataModule):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
DESCRIPTION NEEDS REFINING! Duplicate a DataModule.
Parameters
srcModuleId:String — ID (GUID) of the source data module.
| |
newModule:DataModule — The new module object.
|
com.adobe.icc.token:IAsyncToken — A new DataModule which is a copy of the source data module.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createDataModule | () | method |
public function createDataModule(newModule:DataModule):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Creats a new module and persists it.
Parameters
newModule:DataModule — The new module to create/persist.
|
com.adobe.icc.token:IAsyncToken — The new DataModule object that was persisted.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createTestDataModule | () | method |
public function createTestDataModule(moduleId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Creates a test version of the specified module.
Parameters
moduleId:String — The ID (GUID) of the module.
|
com.adobe.icc.token:IAsyncToken — The new test DataModule object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
dataModuleExists | () | method |
public function dataModuleExists(name:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Determines if the specified data module exists.
Parameters
name:String — Version-independent name of the data module.
|
com.adobe.icc.token:IAsyncToken — Boolean which is true if the data module exists; false if not.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
deleteDataModule | () | method |
public function deleteDataModule(moduleId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Deletes a data module
Parameters
moduleId:String — The ID (GUID) of the module.
|
com.adobe.icc.token:IAsyncToken —
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getAllDataModules | () | method |
public function getAllDataModules(query:Query = null):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Returns a list of data modules based on a query.
Parameters
query:Query (default = null) |
com.adobe.icc.token:IAsyncToken — An ArrayCollection of DataModule objects.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDataModule | () | method |
public function getDataModule(moduleId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a Data Module.
Parameters
moduleId:String — The ID (GUID) of the data module to retrieve.
|
com.adobe.icc.token:IAsyncToken — A DataModule object representing the data module sought.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDataModuleByVersion | () | method |
public function getDataModuleByVersion(moduleId:String, date:Date):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Retrieves a Data Module By Version.
Parameters
moduleId:String — The ID (GUID) of the data module to retrieve.
| |
date:Date — The date at the module was published.
|
com.adobe.icc.token:IAsyncToken — A DataModule object representing the data module sought.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentLetterList | () | method |
public function getDependentLetterList(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieve a list of letters that depend on the specified module.
Parameters
moduleId:String — The ID (GUID) of the data module whose letter dependencies are sought.
| |
fetchIndirectReferences:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — ArrayCollection of Letter objects that represent the letters that depend on the specified data module.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentLetters | () | method |
public function getDependentLetters(moduleId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieve a direct list of letters that depend on the specified module.
Parameters
moduleId:String — The ID (GUID) of the data module whose letter dependencies are sought.
|
com.adobe.icc.token:IAsyncToken — ArrayCollection of Letter objects that represent the letters that depend on the specified data module.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentModuleList | () | method |
public function getDependentModuleList(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieve a list of modules that depend on the specified module. For instance, a list or conditional module may use the specified module as an item or case result, respectively.
Parameters
moduleId:String — The ID (GUID) of the data module whose module dependencies are sought.
| |
fetchIndirectReferences:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — ArrayCollection of DataModule objects that represent the modules that depend on the specified data module.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentModules | () | method |
public function getDependentModules(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Retrieve a list of modules that depend on the specified module. For instance, a list or conditional module may use the specified module as an item or case result, respectively.
Parameters
moduleId:String — The ID (GUID) of the data module whose module dependencies are sought.
| |
fetchIndirectReferences:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — ArrayCollection of DataModule objects that represent the modules that depend on the specified data module.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getUsedDataModules | () | method |
public function getUsedDataModules(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieve the list of other modules that is used by the module identified by the given moduleID.
Parameters
moduleId:String — ID of the data module, for which the used modules are to be fetched.
| |
fetchIndirectReferences:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — List of other modules that is used by the data module. Empty list returned, if the
module does not use any other module.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
isModuleReferenced | () | method |
public function isModuleReferenced(moduleId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Determine if the specified module is reference by some other asset (e.g. a letter or some other module).
Parameters
moduleId:String — The ID (GUID) of the data module in question.
|
com.adobe.icc.token:IAsyncToken — Boolean which is true if the module is reference by another asset; false if it isn't (has no dependents).
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
markReadyToPublish | () | method |
public function markReadyToPublish(srcModuleId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Marks for Publish an existing module in the database.
Parameters
srcModuleId:String — Id of the dataModule.
|
com.adobe.icc.token:IAsyncToken — The updated DataModule object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
publishDataModule | () | method |
public function publishDataModule(srcModuleId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Publishes an existing module in the database.
Parameters
srcModuleId:String — Id of the dataModule.
|
com.adobe.icc.token:IAsyncToken — The updated DataModule object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
revertToLastPublish | () | method |
public function revertToLastPublish(srcModuleId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Reverts the data module to the last published version. If module is not published, it is removed from repository.
Parameters
srcModuleId:String — Id of the data module.
|
com.adobe.icc.token:IAsyncToken — The reverted data module object
|
updateDataModule | () | method |
public function updateDataModule(module:DataModule):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Update an existing module in the database.
Parameters
module:DataModule — Data module holding the updated information.
|
com.adobe.icc.token:IAsyncToken — The updated DataModule object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
Mon Apr 10 2017, 12:28 PM -07:00