com.adobe.dct.service

# DataDictionaryUtilService - AS3 Data Dictionary

Package | com.adobe.dct.service
Interface | public interface DataDictionaryUtilService

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The interface for DataDictionaryUtilService

Public Methods

| Method | Defined By
--- | --- | ---
|  | createDDInstanceFromXml(dataDictionaryName:String, xml:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Creates the data dictionary instance(DDI)corresponding to a Data Dictionary using an input XML. | DataDictionaryUtilService
|  | exportDataDictionaryAsFML(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Exports a data dictionary into a fiber model which can be imported back to obtain the data dictionary. | DataDictionaryUtilService
|  | getDataDictionaryFromFML(dataDictionaryName:String, fml:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Deprecated since LCDCT 10: Please Use getDataDictionaryFromFML2 Generates a data dictionary from the input fiber model | DataDictionaryUtilService
|  | getDataDictionaryFromFML2(dataDictionaryName:String, fml:String, entityName:String, serviceName:String, operationName:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Generates a data dictionary from the input fiber model | DataDictionaryUtilService
|  | getDataDictionaryFromXSD(dataDictionaryName:String, xmlSchema:String, elementName:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Generates a data dictionary from the passed XML Schema | DataDictionaryUtilService
|  | getDDIFromRemotingService(dataDictionaryId:String, remotingServiceOperationParams:Array, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken This API uses the LCDS Remoting Service details from the Data Dictionary and connects to the same for making a LCDS Remoting invocation. | DataDictionaryUtilService
|  | getSampleXMLDataForDD(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Generates sample XML data which can be used for creating a data dictionary instance | DataDictionaryUtilService
|  | hasCommonCollectionHierarchy(dataDictionaryId:String, listHavingListOfDDEDisplayNames:IList, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken This verifies whether the collection elements are used in appropriate hierarchy. | DataDictionaryUtilService
|  | serializeDDItoXML(dataDictionaryInstance:DataDictionaryInstance, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Generates a XML data representing the input Data Dictionary Instance | DataDictionaryUtilService

Method Detail

### createDDInstanceFromXml

()
method

`public function createDDInstanceFromXml(dataDictionaryName:String, xml:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Creates the data dictionary instance(DDI)corresponding to a Data Dictionary using an input XML.

Parameters

| `dataDictionaryName:String` — the name of Data Dictionary for which the DDI is to be created
| `xml:String` — the xml input compliant to the XML Schema bindings in Data Dictionary. The DDI is created from the data inside this XML.
| `clientHandler:Function` (default = `null`)`` — This method is called by the service when the asynchronous request completes and the return value has been received.
| `errorHandler:Function` (default = `null`)`` — This method is called by a service when the asynchronous request completes and an error has been received.

Returns

| `mx.rpc:AsyncToken` — AsyncToken = The `DataDictionaryInstance` corresponding to input XML.

### exportDataDictionaryAsFML

()
method

`public function exportDataDictionaryAsFML(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Exports a data dictionary into a fiber model which can be imported back to obtain the data dictionary.

Parameters

| `dataDictionaryId:String` — the Id of Data Dictionary for which FML is to exported.
| `clientHandler:Function` (default = `null`)`` — This method is called by the service when the asynchronous request completes and the return value has been received.
| `errorHandler:Function` (default = `null`)`` — This method is called by a service when the asynchronous request completes and an error has been received.

Returns

| `mx.rpc:AsyncToken` — AsyncToken- the fiber model/fml corresponding to Data Dictionary as String)

### getDataDictionaryFromFML

()
method

`public function getDataDictionaryFromFML(dataDictionaryName:String, fml:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken`
Deprecated since LCDCT 10: Please Use getDataDictionaryFromFML2

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Generates a data dictionary from the input fiber model

Parameters

| `dataDictionaryName:String` — name by which the data dictionary is to be generated.
| `fml:String` — Fiber Model for creating data dictionary.
| `clientHandler:Function` (default = `null`)`` — This method is called by the service when the asynchronous request completes and the return value has been received.
| `errorHandler:Function` (default = `null`)`` — This method is called by a service when the asynchronous request completes and an error has been received.

Returns

| `mx.rpc:AsyncToken` — AsyncToken - DataDictionary created from Fiber Model\LiveCycle Data Model

### getDataDictionaryFromFML2

()
method

`public function getDataDictionaryFromFML2(dataDictionaryName:String, fml:String, entityName:String, serviceName:String, operationName:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Generates a data dictionary from the input fiber model

Parameters

| `dataDictionaryName:String` — name by which the data dictionary is to be generated.
| `fml:String` — Fiber Model for creating data dictionary.
| `entityName:String` — the root ntity to be picked from FML for creating data dictionary
| `serviceName:String` — - is used to select the Service if there are more then one services defined in the FML.
| `operationName:String` — - is used to select the Operation if there are more then one operations available in the selected Service..
| `clientHandler:Function` (default = `null`)`` — This method is called by the service when the asynchronous request completes and the return value has been received.
| `errorHandler:Function` (default = `null`)`` — This method is called by a service when the asynchronous request completes and an error has been received.

Returns

| `mx.rpc:AsyncToken` — AsyncToken - DataDictionary created from Fiber Model (LiveCycle Data Model)

### getDataDictionaryFromXSD

()
method

`public function getDataDictionaryFromXSD(dataDictionaryName:String, xmlSchema:String, elementName:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Generates a data dictionary from the passed XML Schema

Parameters

| `dataDictionaryName:String` — name by which the data dictionary is to be generated.
| `xmlSchema:String` — XSD/XML Schema for creating data dictionary.
| `elementName:String` — the top level element to be picked from XSD for creating data dictionary.
| `clientHandler:Function` (default = `null`)`` — This method is called by the service when the asynchronous request completes and the return value has been received.
| `errorHandler:Function` (default = `null`)`` — This method is called by a service when the asynchronous request completes and an error has been received.

Returns

| `mx.rpc:AsyncToken` — AsyncToken - DataDictionary created from XML Schema

### getDDIFromRemotingService

()
method

`public function getDDIFromRemotingService(dataDictionaryId:String, remotingServiceOperationParams:Array, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

This API uses the LCDS Remoting Service details from the Data Dictionary and connects to the same for making a LCDS Remoting invocation. The POJO obtained from the invocation is then used to create a Data Dictionary Instance.

Parameters

| `dataDictionaryId:String` — - Data Dictionary Id for which the Data Dictionary Instance is to be retrieved.
| `remotingServiceOperationParams:Array` — - These parameters are passed to the LCDS Remoting operation.
| `clientHandler:Function` (default = `null`)`` — This method is called by the service when the asynchronous request completes and the return value has been received.
| `errorHandler:Function` (default = `null`)`` — This method is called by a service when the asynchronous request completes and an error has been received.

Returns

| `mx.rpc:AsyncToken` — AsyncToken - the DataDictionaryInstance corresponding to the remoting Service operation parameters

### getSampleXMLDataForDD

()
method

`public function getSampleXMLDataForDD(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Generates sample XML data which can be used for creating a data dictionary instance

Parameters

| `dataDictionaryId:String` — the Id of Data Dictionary for which Sample XML is to exported.
| `clientHandler:Function` (default = `null`)`` — This method is called by the service when the asynchronous request completes and the return value has been received.
| `errorHandler:Function` (default = `null`)`` — This method is called by a service when the asynchronous request completes and an error has been received.

Returns

| `mx.rpc:AsyncToken` — AsyncToken - sample XML data as String

### hasCommonCollectionHierarchy

()
method

`public function hasCommonCollectionHierarchy(dataDictionaryId:String, listHavingListOfDDEDisplayNames:IList, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

This verifies whether the collection elements are used in appropriate hierarchy. Two important rules are applied in order to verify the hierarchy. First Rule : All collection elements at the same level have a common collection hierarchy. Second Rule: The collection elements used at a higher level(Level = n) should be at higher depth than the deepest element of all its previous lower levels (0 <= Level < n). The deepest element is the element farthest from root Data Dictionary Element in the Data Dictionary hierarchy.

Parameters

| `dataDictionaryId:String` — the ID of Data Dictionary for which the elements are to be validated.
| `listHavingListOfDDEDisplayNames:IList` — list containing lists of DDE display names (at different levels)
| `clientHandler:Function` (default = `null`)`` — This method is called by the service when the asynchronous request completes and the return value has been received.
| `errorHandler:Function` (default = `null`)`` — This method is called by a service when the asynchronous request completes and an error has been received.

Returns

| `mx.rpc:AsyncToken` — AsyncToken - a boolean representing whether the collection elements are used in appropriate hierarchy

### serializeDDItoXML

()
method

`public function serializeDDItoXML(dataDictionaryInstance:DataDictionaryInstance, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Generates a XML data representing the input Data Dictionary Instance

Parameters

| `dataDictionaryInstance:DataDictionaryInstance` — the Data Dictionary Instance corresponding to which the XML is to be generated.
| `clientHandler:Function` (default = `null`)`` — This method is called by the service when the asynchronous request completes and the return value has been received.
| `errorHandler:Function` (default = `null`)`` — This method is called by a service when the asynchronous request completes and an error has been received.

Returns

| `mx.rpc:AsyncToken` — AsyncToken - the serialized DataDictionaryInstance corresponding to XML

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00