(Beta)
| 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 1.0, 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 | |
Duplicates a Data module. | IModuleService | ||
Creates 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 | ||
getDependentLetterList(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
Retrieves a list of letters that depend on the specified module. | IModuleService | ||
getDependentLetterListForPrompt(moduleId:String, fetchIndirectReferences:Boolean = false, maxAssetCount:int = 5, fetchOnlyTopLevelAttr:Boolean = true):com.adobe.icc.token:IAsyncToken
Retrieves a specified number 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
Retrieves a list of modules that depend on the specified module. | IModuleService | ||
getDependentModuleListForPrompt(moduleId:String, fetchIndirectReferences:Boolean = false, maxAssetCount:int = 5, fetchOnlyTopLevelAttr:Boolean = true):com.adobe.icc.token:IAsyncToken
Retrieves a specified number of modules that depend on the specified module. | IModuleService | ||
Retrieve a list of direct 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 | |
Determines if the specified module is referenced by another asset. | IModuleService | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Updates 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 1.0, Flash Player 9, Flash Player 10 |
Activates the specified data module.
Parameters
moduleId:String — The identifier of the module. The identifier is the GUID.
| |
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 1.0, Flash Player 9, Flash Player 10 |
Duplicates a Data module.
Parameters
srcModuleId:String — The identifier of the source data module. The identifier is the GUID.
| |
newModule:DataModule — The new module object.
|
com.adobe.icc.token:IAsyncToken — A new DataModule that 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 1.0, Flash Player 9, Flash Player 10 |
Creates a new module and persists it. That is, it stores it.
Parameters
newModule:DataModule — The new module to create and 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 1.0, Flash Player 9, Flash Player 10 |
Creates a test version of the specified module.
Parameters
moduleId:String — The identifier of the module. The identifier is the GUID.
|
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 1.0, Flash Player 9, Flash Player 10 |
Determines if the specified data module exists.
Parameters
name:String — The name of the data module. The name of the data module is not associated with a specific version.
|
com.adobe.icc.token:IAsyncToken — A Boolean that is true if the data module exists. It is false if the data module does not exist.
|
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 1.0, Flash Player 9, Flash Player 10 |
Deletes a data module.
Parameters
moduleId:String — The identifier of the module. The identifier is the GUID.
|
com.adobe.icc.token:IAsyncToken — Success in response if deleted successfully
|
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 1.0, 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 1.0, Flash Player 9, Flash Player 10 |
Retrieves a Data module.
Parameters
moduleId:String — The identifier of the data module to retrieve. The identifier is the GUID.
|
com.adobe.icc.token:IAsyncToken — A DataModule object that represents the data module to retrieve.
|
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 1.0, Flash Player 9, Flash Player 10 |
Retrieves a list of letters that depend on the specified module.
Parameters
moduleId:String — The identifier of the data module whose letter dependencies are to be retrieved.
| |
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.
|
getDependentLetterListForPrompt | () | method |
public function getDependentLetterListForPrompt(moduleId:String, fetchIndirectReferences:Boolean = false, maxAssetCount:int = 5, fetchOnlyTopLevelAttr:Boolean = true):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves a specified number of letters that depend on the specified module.
Parameters
moduleId:String — The identifier of the data module whose letter dependencies are to be retrieved.
| |
fetchIndirectReferences:Boolean (default = false) | |
maxAssetCount:int (default = 5) | |
fetchOnlyTopLevelAttr:Boolean (default = true) |
com.adobe.icc.token:IAsyncToken — Object containing count of total dependent letters (against key 'Count') and List of Letters dependent on the given Fragment containing maximum
|
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 1.0, 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 1.0, Flash Player 9, Flash Player 10 |
Retrieves a list of modules that depend on the specified module. For instance, a list that uses the specified module as an item or a conditional module that uses the module as a case result.
Parameters
moduleId:String — The identifier of the data module whose module dependencies are to be retrieved.
| |
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.
|
getDependentModuleListForPrompt | () | method |
public function getDependentModuleListForPrompt(moduleId:String, fetchIndirectReferences:Boolean = false, maxAssetCount:int = 5, fetchOnlyTopLevelAttr:Boolean = true):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves a specified number of modules that depend on the specified module. For instance, a list that uses the specified module as an item or a conditional module that uses the module as a case result.
Parameters
moduleId:String — The identifier of the data module whose module dependencies are to be retrieved.
| |
fetchIndirectReferences:Boolean (default = false) | |
maxAssetCount:int (default = 5) | |
fetchOnlyTopLevelAttr:Boolean (default = true) |
com.adobe.icc.token:IAsyncToken — Object containing count of total dependent letters (against key 'Count') and List of Letters dependent on the given Fragment containing maximum
|
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):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieve a list of direct 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.
|
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 1.0, 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 1.0, Flash Player 9, Flash Player 10 |
Determines if the specified module is referenced by another asset. For example, a letter or another module.
Parameters
moduleId:String — The identifier of the data module in question. The identifier is the GUID.
|
com.adobe.icc.token:IAsyncToken — A Boolean that is true if the module is referenced by another asset.
It is false if the module is not referenced by another asset. That is, it 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.
|
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 1.0, Flash Player 9, Flash Player 10 |
Updates an existing module in the database.
Parameters
module:DataModule — Data module that holds 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.
|
Wed Nov 21 2018, 06:34 AM -08:00