DataDictionaryUtilService - BETA ActionScript® 3 (AS3 Data Dictionary) Reference for the Adobe® Flash® Platform API Reference

(Beta)

Package	com.adobe.dct.service
Interface	public interface DataDictionaryUtilService
Implementors	DataDictionaryUtilServiceImpl

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The interface for DataDictionaryUtilService

Public Methods

	Method		Defined By
		createDDInstanceFromXml(dataDictionaryName:String, xml:String, clientHandler:Function = null, errorHandler:Function = null, ddiOptionsSpec:DDIOptionsSpec = null):mx.rpc:AsyncToken Creates a data dictionary instance using XML.	DataDictionaryUtilService
		exportDataDictionaryAsFML(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Exports a data dictionary to an application model, which allows a data dictionary to be generated from the model.	DataDictionaryUtilService
		getDataDictionaryFromFML(dataDictionaryName:String, fml:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Generates a data dictionary from the specified 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
		getSampleXMLDataForDD(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Generates sample XML data that can be used to create an instance of a data dictionary.	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, ddiOptionsSpec:DDIOptionsSpec = null):mx.rpc:AsyncToken

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Creates a data dictionary instance using XML.

Parameters

	`dataDictionaryName:String` — The name of the data dictionary to create the data dictionary instance for.

	`xml:String` — The XML input that is compliant to the XML schema bindings in the Data Dictionary. The data dictionary instance is created using the data in this XML.

	`clientHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and the return value is received.

	`errorHandler:Function` (default = `null`) — This method is called by a service when the asynchronous request completes and an error is received.

	`ddiOptionsSpec:DDIOptionsSpec` (default = `null`)

Returns

mx.rpc:AsyncToken — AsyncToken An instance of mx.rpc.AsyncToken. You can extract the response of the call from ResultEvent or FaultEvent through handler or responder. ResultEvent.result contains the data dictionary instance that is created.

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 1.0, Flash Player 9, Flash Player 10

Exports a data dictionary to an application model, which allows a data dictionary to be generated from the model.

Parameters

	`dataDictionaryId:String` — The identifier of the data dictionary to export the application model from.

	`clientHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and the return value is received.

	`errorHandler:Function` (default = `null`) — The method called by a service when the asynchronous request completes and an error is received.

Returns

getDataDictionaryFromFML

()

method

 public function getDataDictionaryFromFML(dataDictionaryName:String, fml: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 1.0, Flash Player 9, Flash Player 10

Generates a data dictionary from the specified model.

Parameters

	`dataDictionaryName:String` — The name of the data dictionary to generate.

	`fml:String` — Application model to generate the data dictionary from.

	`clientHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and the return value is received.

	`errorHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and an error is received.

Returns

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 1.0, Flash Player 9, Flash Player 10

Generates a data dictionary from the passed XML schema.

Parameters

	`dataDictionaryName:String` — The name of the data dictionary to generate.

	`xmlSchema:String` — The XSD or XML schema to generate the data dictionary from.

	`elementName:String` — The top-level element selected from the XSD schema for creating data dictionary.

	`clientHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and the return value is received.

	`errorHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and an error is received.

Returns

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 1.0, Flash Player 9, Flash Player 10

Generates sample XML data that can be used to create an instance of a data dictionary.

Parameters

	`dataDictionaryId:String` — The identifier of the data dictionary to export sample XML to.

	`clientHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and the return value is received.

	`errorHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and an error is received.

Returns

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 1.0, Flash Player 9, Flash Player 10

Generates a XML data representing the input Data Dictionary Instance

Parameters

	`dataDictionaryInstance:DataDictionaryInstance` — The data dictionary instance that is used to create XML. The XML output is compliant to the XML schema bindings in the Data Dictionary.

	`clientHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and the return value is received.

	`errorHandler:Function` (default = `null`) — The method called by the service when the asynchronous request completes and an error is received.

Returns

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

DataDictionaryUtilService - AS3 Data Dictionary

Classes x

createDDInstanceFromXml

exportDataDictionaryAsFML

getDataDictionaryFromFML

getDataDictionaryFromXSD

getSampleXMLDataForDD

serializeDDItoXML