DataDictionaryRegistryService - Adobe ActionScript® 3 (AS3 Data Dictionary) API Reference

Package	com.adobe.dct.service
Interface	public interface DataDictionaryRegistryService

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The interface for DataDictionaryRegistryService

Public Methods

	Method		Defined By
		createDataDictionary(dataDictionary:DataDictionary, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Creates a data dictionary in a persistent store and returns the unique identifier of the stored data dictionary.	DataDictionaryRegistryService
		deleteDataDictionary(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Deletes a data dictionary from the persistent store.	DataDictionaryRegistryService
		getAllDataDictionaries(clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Returns all data dictionaries.	DataDictionaryRegistryService
		getAllDataDictionaryReferences(clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Returns all data dictionary references.	DataDictionaryRegistryService
		getDataDictionaries(searchFilter:DataDictionarySearchFilter, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Returns all data dictionaries that meet the criteria specified in a search filter.	DataDictionaryRegistryService
		getDataDictionary(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Returns a data dictionary object that corresponds to an identifier.	DataDictionaryRegistryService
		getDataDictionaryReferences(searchFilter:DataDictionarySearchFilter, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Returns all data dictionary references that meet the criteria specified in a search filter.	DataDictionaryRegistryService
		getSystemDataDictionaries(clientHandler:Function = null, errorHandler:Function = null, locale:String = null):mx.rpc:AsyncToken Returns all system data dictionaries.	DataDictionaryRegistryService
		markReadyToPublish(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Mark the given Data Dictionary read to Publish.	DataDictionaryRegistryService
		publishDataDictionary(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Publish the data dictionary identified by the given dataDictionaryId.	DataDictionaryRegistryService
		revertToLastPublished(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Revert to the last published version of the data dictionary identified by the given dataDictionaryId.	DataDictionaryRegistryService
		updateDataDictionary(dataDictionary:DataDictionary, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Updates an existing data dictionary.	DataDictionaryRegistryService

Method Detail

createDataDictionary

()

method

 public function createDataDictionary(dataDictionary:DataDictionary, 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 a data dictionary in a persistent store and returns the unique identifier of the stored data dictionary.

Parameters

	`dataDictionary:DataDictionary` — The DataDictionary object.

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

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 unique identifier of the stored data dictionary.

deleteDataDictionary

()

method

 public function deleteDataDictionary(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

Deletes a data dictionary from the persistent store.

Parameters

	`dataDictionaryId:String` — The identifier of the data dictionary to delete.

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

Returns

mx.rpc:AsyncToken — AsyncToken A token that allows you register for the event. Add a listener for ResultEvent to detect if the call to the server is successful. The value of ResultEvent.result is null, that is, it does not hold any information.

getAllDataDictionaries

()

method

public function getAllDataDictionaries(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

Returns all data dictionaries.

Parameters

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

Returns

getAllDataDictionaryReferences

()

method

 public function getAllDataDictionaryReferences(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

Returns all data dictionary references.

Parameters

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

Returns

getDataDictionaries

()

method

 public function getDataDictionaries(searchFilter:DataDictionarySearchFilter, 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

Returns all data dictionaries that meet the criteria specified in a search filter.

Parameters

	`searchFilter:DataDictionarySearchFilter` — The criteria for a data dictionary search, such as name or type.

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

Returns

getDataDictionary

()

method

 public function getDataDictionary(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

Returns a data dictionary object that corresponds to an identifier.

Parameters

	`dataDictionaryId:String` — The unique identifier for 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`) — This method is called by a service when the asynchronous request completes and an error is received.

Returns

getDataDictionaryReferences

()

method

 public function getDataDictionaryReferences(searchFilter:DataDictionarySearchFilter, 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

Returns all data dictionary references that meet the criteria specified in a search filter.

Parameters

	`searchFilter:DataDictionarySearchFilter` — The criteria for a data dictionary search, such as name or type.

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

Returns

getSystemDataDictionaries

()

method

 public function getSystemDataDictionaries(clientHandler:Function = null, errorHandler:Function = null, locale:String = 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

Returns all system data dictionaries.

Parameters

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

	`locale:String` (default = `null`) — The locale that specifies the user's language. This operation is locale-sensitive and uses the locale to customize information for the user.

Returns

markReadyToPublish

()

method

 public function markReadyToPublish(dataDictionaryId: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

Mark the given Data Dictionary read to Publish.

Parameters

	`dataDictionaryId:String` — data dictionary identifier

	`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 — DataDictionary

publishDataDictionary

()

method

 public function publishDataDictionary(dataDictionaryId: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

Publish the data dictionary identified by the given dataDictionaryId.

Parameters

	`dataDictionaryId:String` — data dictionary identifier

	`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 — DataDictionary

revertToLastPublished

()

method

 public function revertToLastPublished(dataDictionaryId: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

Revert to the last published version of the data dictionary identified by the given dataDictionaryId.

Parameters

	`dataDictionaryId:String` — data dictionary identifier

	`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 — DataDictionary

updateDataDictionary

()

method

 public function updateDataDictionary(dataDictionary:DataDictionary, 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

Updates an existing data dictionary. The data dictionary must have the specified name and identifier.

Name and identifier fields are mandatory for a data dictionary. The data dictionary name is unique and case-insensitive. If the name is not unique, a fault is thrown.

Parameters

	`dataDictionary:DataDictionary` — The data dictionary to update.

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

Returns

DataDictionaryRegistryService - AS3 Data Dictionary

Classes x

createDataDictionary

deleteDataDictionary

getAllDataDictionaries

getAllDataDictionaryReferences

getDataDictionaries

getDataDictionary

getDataDictionaryReferences

getSystemDataDictionaries

markReadyToPublish

publishDataDictionary

revertToLastPublished

updateDataDictionary

com.adobe.dct.service DataDictionaryRegistryService - AS3 Data Dictionary		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples