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

(Beta)

Package	com.adobe.dct.service.impl
Class	public class DataDictionaryRegistryServiceImpl
Inheritance	DataDictionaryRegistryServiceImpl EventDispatcher Object
Implements	DataDictionaryRegistryService

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 implementation class for DataDictionaryRegistryService.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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.	EventDispatcher
		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.	DataDictionaryRegistryServiceImpl
		deleteDataDictionary(dataDictioaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Deletes a data dictionary from the persistent store.	DataDictionaryRegistryServiceImpl
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getAllDataDictionaries(clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Returns all data dictionaries.	DataDictionaryRegistryServiceImpl
		getAllDataDictionaryReferences(clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Returns all data dictionary references.	DataDictionaryRegistryServiceImpl
		getDataDictionaries(searchFilter:DataDictionarySearchFilter, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Returns all data dictionaries that meet the criteria that are specified in a search filter.	DataDictionaryRegistryServiceImpl
		getDataDictionary(dataDictionaryId:String, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Returns a data dictionary object that corresponds to a unique identifier.	DataDictionaryRegistryServiceImpl
		getDataDictionaryReferences(searchFilter:DataDictionarySearchFilter, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Obtains all data dictionary references that meet the criteria that are specified in a search filter.	DataDictionaryRegistryServiceImpl
		getInstance():DataDictionaryRegistryServiceImpl [static] A static method that retrieves the DataDictionaryRegistryServiceImpl instance as a singleton object.	DataDictionaryRegistryServiceImpl
		getSystemDataDictionaries(clientHandler:Function = null, errorHandler:Function = null, locale:String = null):mx.rpc:AsyncToken Returns all system data dictionaries.	DataDictionaryRegistryServiceImpl
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		updateDataDictionary(dataDictionary:DataDictionary, clientHandler:Function = null, errorHandler:Function = null):mx.rpc:AsyncToken Updates an existing data dictionary.	DataDictionaryRegistryServiceImpl
		valueOf():Object Returns the primitive value of the specified object.	Object
		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.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

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

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 through a fault handler or responder. ResultEvent.result contains the unique identifier of the stored data dictionary.

deleteDataDictionary

()

method

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

Deletes a data dictionary from the persistent store.

Parameters

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

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

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

Returns all data dictionaries that meet the criteria that are 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 1.0, Flash Player 9, Flash Player 10

Returns a data dictionary object that corresponds to a unique 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 1.0, Flash Player 9, Flash Player 10

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

Parameters

	`searchFilter:DataDictionarySearchFilter` — The method called by the service when the asynchronous request completes and the return value is received.

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

	`errorHandler:Function` (default = `null`) — The criteria for a data dictionary search, such as name or type.

Returns

getInstance

()

method

public static function getInstance():DataDictionaryRegistryServiceImpl

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

A static method that retrieves the DataDictionaryRegistryServiceImpl instance as a singleton object.

Returns

DataDictionaryRegistryServiceImpl — An instance of DataDictionaryRegistryServiceImpl.

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

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

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

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

Name and ID fields are mandatory for a data dictionary. The data dictionary name is unique and case insensitive. If a 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

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

DataDictionaryRegistryServiceImpl - AS3 Data Dictionary

Classes x

createDataDictionary

deleteDataDictionary

getAllDataDictionaries

getAllDataDictionaryReferences

getDataDictionaries

getDataDictionary

getDataDictionaryReferences

getInstance

getSystemDataDictionaries

updateDataDictionary