ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.icc.services.fragmentlayout 

IFragmentLayoutService  - AS3 Asset Composer
Packagecom.adobe.icc.services.fragmentlayout
Interfacepublic interface IFragmentLayoutService extends IEventDispatcher

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Defines a service for Fragment Layout management.


Public Methods
 MethodDefined By
  
activateFragmentLayout(fragmentLayoutId:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken
Activates a fragmentLayout template
IFragmentLayoutService
 Inherited
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
  
copyFragmentLayout(oldFragmentLayoutID:String, newFragmentLayout:FragmentLayout):com.adobe.icc.token:IAsyncToken
Creates a copy of an existing fragmentLayout.
IFragmentLayoutService
  
createFragmentLayout(fragmentLayout:FragmentLayout):com.adobe.icc.token:IAsyncToken
Creates a new fragmentLayout template record
IFragmentLayoutService
  
createTestFragmentLayout(fragmentLayoutID:String):com.adobe.icc.token:IAsyncToken
For creating a test version of a fragmentLayout template.
IFragmentLayoutService
  
deleteFragmentLayout(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken
Allows deleting of a fragmentLayout.
IFragmentLayoutService
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
IEventDispatcher
  
fragmentLayoutExists(name:String):com.adobe.icc.token:IAsyncToken
Determines if the specified fragmentLayout exists.
IFragmentLayoutService
  
getAllFragmentLayouts(query:Query = null):com.adobe.icc.token:IAsyncToken
Returns a list of available fragmentLayout templates.
IFragmentLayoutService
  
getDependentLetters(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken
Retrieves a list of letters that are dependent on the specified fragmentLayout (i.e.
IFragmentLayoutService
  
getFragmentLayout(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken
Retrieves a fragmentLayout given its unique identifier.
IFragmentLayoutService
  
getFragmentLayoutByVersion(fragmentLayoutId:String, date:Date):com.adobe.icc.token:IAsyncToken
Retrieves a fragmentLayout given its unique identifier and date on which the fragment was published.
IFragmentLayoutService
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
markReadyToPublish(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken
Mark as ready to publish the FragmentLayout identified by the given fragmentLayoutID.
IFragmentLayoutService
  
parseFragmentLayout(fragmentLayout:FragmentLayout):com.adobe.icc.token:IAsyncToken
Parses fragment layout and populates target areas, fields and tables in it.
IFragmentLayoutService
  
publishFragment(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken
Publish the FragmentLayout identified by the given FragmentLayoutID.
IFragmentLayoutService
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
revertToLastPublish(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken
Reverts the fragment layout to the last published version.
IFragmentLayoutService
  
updateFragmentLayout(fragmentLayout:FragmentLayout):com.adobe.icc.token:IAsyncToken
Allows updating a fragmentLayout template with state test
IFragmentLayoutService
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Method Detail

activateFragmentLayout

()method
public function activateFragmentLayout(fragmentLayoutId:String, updateDependencies: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

Activates a fragmentLayout template

Parameters

fragmentLayoutId:String — The ID (GUID) of the fragmentLayout to activate
 
updateDependencies:Boolean (default = false) — Whether to replace/use this new activated version in the dependencies

Returns
com.adobe.icc.token:IAsyncToken — the updated FragmentLayout

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

copyFragmentLayout

()method 
public function copyFragmentLayout(oldFragmentLayoutID:String, newFragmentLayout:FragmentLayout):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

Creates a copy of an existing fragmentLayout.

Parameters

oldFragmentLayoutID:String — Identifier of the fragment layout to be copied.
 
newFragmentLayout:FragmentLayout — may optionally specify a new test data file but original XDP fragmentLayout cannot be altered

Returns
com.adobe.icc.token:IAsyncToken — New fragmentLayout 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.

createFragmentLayout

()method 
public function createFragmentLayout(fragmentLayout:FragmentLayout):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

Creates a new fragmentLayout template record

Parameters

fragmentLayout:FragmentLayout — New fragmentLayout object

Returns
com.adobe.icc.token:IAsyncToken — The new FragmentLayout object

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

createTestFragmentLayout

()method 
public function createTestFragmentLayout(fragmentLayoutID: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

For creating a test version of a fragmentLayout template.

Parameters

fragmentLayoutID:String — The ID (GUID) of an existing FragmentLayout to duplicate as a test version

Returns
com.adobe.icc.token:IAsyncToken — The new FragmentLayout object

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

deleteFragmentLayout

()method 
public function deleteFragmentLayout(fragmentLayoutId: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

Allows deleting of a fragmentLayout. If the fragmentLayout referenced by fragmentLayoutId has the state test it is physically deleted otherwise if the state is active it is being set to state archive.

Parameters

fragmentLayoutId:String — The ID (GUID) of the fragmentLayout to delete

Returns
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.

fragmentLayoutExists

()method 
public function fragmentLayoutExists(name: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

Determines if the specified fragmentLayout exists.

Parameters

name:String — Version-independent name of the fragmentLayout.

Returns
com.adobe.icc.token:IAsyncToken — Boolean which is true if the fragmentLayout 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.

getAllFragmentLayouts

()method 
public function getAllFragmentLayouts(query:Query = null):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

Returns a list of available fragmentLayout templates.

Parameters

query:Query (default = null) — Query specifying the statements for filtering search results.

Returns
com.adobe.icc.token:IAsyncToken — An ArrayCollection containing FragmentLayout 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(fragmentLayoutId: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

Retrieves a list of letters that are dependent on the specified fragmentLayout (i.e. that use the specified fragmentLayout as their layout).

Parameters

fragmentLayoutId:String — The unique identifer of the fragmentLayout whose dependent letters are sought.

Returns
com.adobe.icc.token:IAsyncToken — ArrayCollection of Letter objects that are dependent on the specified fragmentLayout.

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

getFragmentLayout

()method 
public function getFragmentLayout(fragmentLayoutId: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

Retrieves a fragmentLayout given its unique identifier.

Parameters

fragmentLayoutId:String — The unique identifier of the fragmentLayout to retrieve (i.e. it's GUID).

Returns
com.adobe.icc.token:IAsyncToken — The result event's result data will be a FragmentLayout object for the specified fragmentLayout, 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.

getFragmentLayoutByVersion

()method 
public function getFragmentLayoutByVersion(fragmentLayoutId: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 fragmentLayout given its unique identifier and date on which the fragment was published.

Parameters

fragmentLayoutId:String — The unique identifier of the fragmentLayout to retrieve (i.e. it's GUID).
 
date:Date — The date on which the fragment was published.

Returns
com.adobe.icc.token:IAsyncToken — The result event's result data will be a FragmentLayout object for the specified fragmentLayout, 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(fragmentLayoutId: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 FragmentLayout identified by the given fragmentLayoutID.

Parameters

fragmentLayoutId:String — ID of the FragmentLayout

Returns
com.adobe.icc.token:IAsyncToken — FragmentLayout object marked for publishing

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

parseFragmentLayout

()method 
public function parseFragmentLayout(fragmentLayout:FragmentLayout):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

Parses fragment layout and populates target areas, fields and tables in it.

Parameters

fragmentLayout:FragmentLayout — FragmentLayout required to be parsed

Returns
com.adobe.icc.token:IAsyncToken — FragmentLayout populated with target areas, fields and tables.

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

publishFragment

()method 
public function publishFragment(fragmentLayoutId: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 FragmentLayout identified by the given FragmentLayoutID.

Parameters

fragmentLayoutId:String — ID of the FragmentLayout

Returns
com.adobe.icc.token:IAsyncToken — published FragmentLayout 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(fragmentLayoutId: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 fragment layout to the last published version. If fragment layout is not published, it is removed from repository.

Parameters

fragmentLayoutId:String — ID of the FragmentLayout

Returns
com.adobe.icc.token:IAsyncToken — Reverted fragment layout.

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

updateFragmentLayout

()method 
public function updateFragmentLayout(fragmentLayout:FragmentLayout):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

Allows updating a fragmentLayout template with state test

Parameters

fragmentLayout:FragmentLayout — Updated fragmentLayout object

Returns
com.adobe.icc.token:IAsyncToken — Updated fragmentLayout object

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy