套件 | com.adobe.icc.services.module |
介面 | public interface IModuleService extends IEventDispatcher |
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
方法 | 定義自 | ||
---|---|---|---|
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
會在 EventDispatcher 物件註冊事件偵聽程式,以便讓偵聽程式收到事件的通知。 | 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 | ||
會將事件傳送到事件流程。 | 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 | ||
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | 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 | ||
會從 EventDispatcher 物件移除偵聽程式。 | IEventDispatcher | ||
Reverts the data module to the last published version. | IModuleService | ||
Update an existing module in the database. | IModuleService | ||
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式,或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | IEventDispatcher |
activateDataModule | () | 方法 |
public function activateDataModule(moduleId:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Activates the specified data module.
參數
moduleId:String — ID (GUID) of the module.
| |
updateDependencies:Boolean (default = false ) — Whether to replace/use this new activated version in the dependencies.
|
com.adobe.icc.token:IAsyncToken — The activated DataModule object.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
copyDataModule | () | 方法 |
public function copyDataModule(srcModuleId:String, newModule:DataModule):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
DESCRIPTION NEEDS REFINING! Duplicate a DataModule.
參數
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.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createDataModule | () | 方法 |
public function createDataModule(newModule:DataModule):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Creats a new module and persists it.
參數
newModule:DataModule — The new module to create/persist.
|
com.adobe.icc.token:IAsyncToken — The new DataModule object that was persisted.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createTestDataModule | () | 方法 |
public function createTestDataModule(moduleId:String):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Creates a test version of the specified module.
參數
moduleId:String — The ID (GUID) of the module.
|
com.adobe.icc.token:IAsyncToken — The new test DataModule object.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
dataModuleExists | () | 方法 |
public function dataModuleExists(name:String):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Determines if the specified data module exists.
參數
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.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
deleteDataModule | () | 方法 |
public function deleteDataModule(moduleId:String):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Deletes a data module
參數
moduleId:String — The ID (GUID) of the module.
|
com.adobe.icc.token:IAsyncToken —
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getAllDataModules | () | 方法 |
public function getAllDataModules(query:Query = null):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Returns a list of data modules based on a query.
參數
query:Query (default = null ) — Query specifying the statements for filtering search results. If null, all data modules are retrieved.
|
com.adobe.icc.token:IAsyncToken — An ArrayCollection of DataModule objects.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDataModule | () | 方法 |
public function getDataModule(moduleId:String):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a Data Module.
參數
moduleId:String — The ID (GUID) of the data module to retrieve.
|
com.adobe.icc.token:IAsyncToken — A DataModule object representing the data module sought.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDataModuleByVersion | () | 方法 |
public function getDataModuleByVersion(moduleId:String, date:Date):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 10 |
執行階段版本: | AIR (unsupported), Flash Player 10.2 |
Retrieves a Data Module By Version.
參數
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.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentLetterList | () | 方法 |
public function getDependentLetterList(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieve a list of letters that depend on the specified module.
參數
moduleId:String — The ID (GUID) of the data module whose letter dependencies are sought.
| |
fetchIndirectReferences:Boolean (default = false ) — True, if you wish to fetch the Letters that directly or indirectly use this module.
For example, if a Letter L1 uses a Text T1; and another Letter L2 uses List L1, which in turn uses Text T1, then the
List returned would contain (L1 and L2), for the Text T1. If False, the List returned would contain only L1.
(L1 and C1). If false, the List would contain only L1.
|
com.adobe.icc.token:IAsyncToken — ArrayCollection of Letter objects that represent the letters that depend on the specified data module.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentLetters | () | 方法 |
public function getDependentLetters(moduleId:String):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieve a direct list of letters that depend on the specified module.
參數
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.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentModuleList | () | 方法 |
public function getDependentModuleList(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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.
參數
moduleId:String — The ID (GUID) of the data module whose module dependencies are sought.
| |
fetchIndirectReferences:Boolean (default = false ) — True, if you wish to fetch the modules that directly or indirectly use this module.
For example, if a Text T1 is used in a List L1, and List L1 is used in Condition C1, the List would contain
(L1 and C1), for the Text T1. If false, the List would contain only L1.
|
com.adobe.icc.token:IAsyncToken — ArrayCollection of DataModule objects that represent the modules that depend on the specified data module.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentModules | () | 方法 |
public function getDependentModules(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 10 |
執行階段版本: | 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.
參數
moduleId:String — The ID (GUID) of the data module whose module dependencies are sought.
| |
fetchIndirectReferences:Boolean (default = false ) — Fetch direct or indirect references of the module
|
com.adobe.icc.token:IAsyncToken — ArrayCollection of DataModule objects that represent the modules that depend on the specified data module.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getUsedDataModules | () | 方法 |
public function getUsedDataModules(moduleId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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
.
參數
moduleId:String — ID of the data module, for which the used modules are to be fetched.
| |
fetchIndirectReferences:Boolean (default = false ) — True, if you wish to fetch the modules that are directly or indirectly used by this module.
For example, if a Text T1 is used in a List L1, and List L1 is used in Condition C1, the List would contain
(T1 and L1), for the Condition C1. If false, the List would contain only L1.
|
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.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
isModuleReferenced | () | 方法 |
public function isModuleReferenced(moduleId:String):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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).
參數
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).
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
markReadyToPublish | () | 方法 |
public function markReadyToPublish(srcModuleId:String):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 10 |
執行階段版本: | AIR (unsupported), Flash Player 10.2 |
Marks for Publish an existing module in the database.
參數
srcModuleId:String — Id of the dataModule.
|
com.adobe.icc.token:IAsyncToken — The updated DataModule object.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
publishDataModule | () | 方法 |
public function publishDataModule(srcModuleId:String):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 10 |
執行階段版本: | AIR (unsupported), Flash Player 10.2 |
Publishes an existing module in the database.
參數
srcModuleId:String — Id of the dataModule.
|
com.adobe.icc.token:IAsyncToken — The updated DataModule object.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
revertToLastPublish | () | 方法 |
public function revertToLastPublish(srcModuleId:String):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 10 |
執行階段版本: | 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.
參數
srcModuleId:String — Id of the data module.
|
com.adobe.icc.token:IAsyncToken — The reverted data module object
|
updateDataModule | () | 方法 |
public function updateDataModule(module:DataModule):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Update an existing module in the database.
參數
module:DataModule — Data module holding the updated information.
|
com.adobe.icc.token:IAsyncToken — The updated DataModule object.
|
擲回值
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
Tue Jun 12 2018, 03:47 PM Z