AfDataContainer Class [AX 2012]

The AfDataContainer class implements generic weakly typed data containers.

Syntax

class AfDataContainer implements SysPackable

Run On

Called

Methods

	Method	Description
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	clear	Removes every data item from the data container.
	contains	Determines whether the data container contains a data item with the specified name.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	get_Array	Gets the value of the specified array.
	get_Attribute	Gets the value of the specified primitive data item.
	get_Container	Gets the value of the specified container.
	get_Count	Gets the number of data items in the container.
	get_Descriptor	Gets the descriptor for the data container.
	get_EdtArray	Gets the value of the specified extended data item.
	get_Enumerator	Gets a data container enumerator.
	get_Item	Gets the value of the specified data item.
	get_List	Gets the value of the data container list.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	new	Initializes a new instance of the AfDataContainer class.
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pack	Serializes the contents of the data container.
	remove	Removes the specified data item.
	set_Array	Sets the value of the specified array.
	set_Attribute	Sets the value of the specified primitive data item.
	set_Container	Sets the value of the specified container.
	set_EdtArray	Sets the value of the specified extended array.
	set_Item	Sets the value of the specified data item
	set_List	Sets the value of the data container list.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	st	Gets a strongly typed data container interface that is associated with the data container.
	swapContents	Swaps the contents of the data container with the specified data container.
	swapStruct	Swaps Struct objects that are used as underlying data storage.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpack	Deserializes the specified container to the current data container.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validateDataItemValue	Validates the given data item value.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

Using data containers, you can get data item values, set data item values, remove data items, remove all data items by clearing the container, determine whether a data container has a data item, enumerate data items that are present in a data container, get the descriptor of the data container, and access the strongly typed interface.

Data containers can support two kinds of data access: weakly typed and strongly typed.

Every data container supports weakly typed data access implemented by the AfDataContainer class. Some data containers support strongly typed data access implemented by a class inherited from the AfStronglyTypedDataContainer class. Both weakly and strongly typed interfaces provide methods to obtain objects that implement the other interface, e.g., the AfDataContainer.st method and the AfStronglyTypedDataContainer.wt method.

Do not instantiate this class directly. Data container instances should only be created by the AfDataContainerFactory class.

For more information, see: the AfStronglyTypedDataContainer Class, the AfDataContainerFactory Class, the AfDataContainerDescriptors Class, and the DataContainerTypes macro.

Inheritance Hierarchy

Object Class
  AfDataContainer Class