| Package | com.adobe.icc.services.layout |
| Interface | public interface ILayoutService 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 | ||
|---|---|---|---|
Activates a form template
| ILayoutService | ||
 | 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 | |
Creates a copy of an existing form. | ILayoutService | ||
Creates a new form template record
| ILayoutService | ||
For creating a test version of a form template. | ILayoutService | ||
Allows deleting of a form. | ILayoutService | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Determines if the specified form exists. | ILayoutService | ||
Returns a list of available form templates. | ILayoutService | ||
Retrieves a list of letters that are dependent on the specified form (i.e. | ILayoutService | ||
Retrieves a form given its unique identifier. | ILayoutService | ||
Retrieves a form given its unique identifier and date on which the form was published. | ILayoutService | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Mark as ready to publish the Layout identified by the given formID. | ILayoutService | ||
Publish the Layout identified by the given formID. | ILayoutService | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Revert the Layout identified by the given formID. | ILayoutService | ||
Allows updating a form template with state test
| ILayoutService | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
activateForm | () | method |
public function activateForm(formId: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 a form template
Parameters
formId:String — The ID (GUID) of the form to activate
| |
updateDependencies:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — the updated Form
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
copyForm | () | method |
public function copyForm(oldFormID:String, newForm:Form):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 copy of an existing form.
Parameters
oldFormID:String — Identifier of the Form to be copied
| |
newForm:Form — may optionally specify a new test data file but original XDP form cannot be altered
|
com.adobe.icc.token:IAsyncToken — New form object (the copy).
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createForm | () | method |
public function createForm(form:Form):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 new form template record
Parameters
form:Form — New form object
|
com.adobe.icc.token:IAsyncToken — The new Form object
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createTestForm | () | method |
public function createTestForm(formID: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 |
For creating a test version of a form template.
Parameters
formID:String — The ID (GUID) of an existing Form to duplicate as a test version
|
com.adobe.icc.token:IAsyncToken — The new Form object
|
Throws
Error | |
Error | |
Error | |
Error |
deleteForm | () | method |
public function deleteForm(formId: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 |
Allows deleting of a form. If the form referenced by formId has the state test it is physically deleted otherwise if the state is active it is being set to state archive.
Parameters
formId:String — The ID (GUID) of the form to delete
|
com.adobe.icc.token:IAsyncToken — Return without any value if delete was successful
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
formExists | () | method |
public function formExists(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 form exists.
Parameters
name:String — Version-independent name of the form.
|
com.adobe.icc.token:IAsyncToken — Boolean which is true if the form 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.
|
getAllForms | () | method |
public function getAllForms(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 available form templates.
Parameters
query:Query (default = null) |
com.adobe.icc.token:IAsyncToken — An ArrayCollection containing Form objects
|
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(formId: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 list of letters that are dependent on the specified form (i.e. that use the specified form as their layout).
Parameters
formId:String — The unique identifer of the form whose dependent letters are sought.
|
com.adobe.icc.token:IAsyncToken — ArrayCollection of Letter objects that are dependent on the specified form.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getForm | () | method |
public function getForm(formId: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 form given its unique identifier.
Parameters
formId:String — The unique identifier of the form to retrieve (i.e. it's GUID).
|
com.adobe.icc.token:IAsyncToken — The result event's result data will be a Form object for the specified form, if the ID was valid.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getFormByVersion | () | method |
public function getFormByVersion(formId: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 form given its unique identifier and date on which the form was published.
Parameters
formId:String — The unique identifier of the form to retrieve (i.e. it's GUID).
| |
date:Date — The date on which the letter was published.
|
com.adobe.icc.token:IAsyncToken — The result event's result data will be a Form object for the specified form, if the ID was valid.
|
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(formId: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 |
Mark as ready to publish the Layout identified by the given formID.
Parameters
formId:String — Id of the Form
|
com.adobe.icc.token:IAsyncToken — Form object marked for publish
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
publishForm | () | method |
public function publishForm(formId: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 |
Publish the Layout identified by the given formID.
Parameters
formId:String — Id of the Form
|
com.adobe.icc.token:IAsyncToken — Published Form 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(formId: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 |
Revert the Layout identified by the given formID.
Parameters
formId:String — Id of the Form
|
com.adobe.icc.token:IAsyncToken — Reverted Form object
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
updateForm | () | method |
public function updateForm(form:Form):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 |
Allows updating a form template with state test
Parameters
form:Form — Updated form object
|
com.adobe.icc.token:IAsyncToken — Updated form 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