AfDataContainerClassGenerator Class [AX 2012]

The AfDataContainerClassGenerator class generates strongly typed data container classes.

Syntax

class AfDataContainerClassGenerator extends AifClassGeneratorBase

Run On

Called

Methods

	Method	Description
	addAttributes	Adds attributes to the class or interface declaration. (Overrides the addAttributes Method.)
	addClassDeclaration	Adds the class declaration to the newly generated class. (Inherited from AifClassGeneratorBase.)
	addClassVariable	Adds a new class level variable. (Inherited from AifClassGeneratorBase.)
	addCreateMethod	Generates the Create method for the specified data item.
	addCustomCode	Generates the strongly typed data container class methods. (Overrides the addCustomCode Method.)
	addDataContainerTypeMacro	Generates a macro for the specified data container type.
	addDataItemMethods	Generates the strongly typed data item methods for all data items.
	addDataItemNameMacro	Adds the data item name macro to the class declaration.
	addDeclaration	Adds the class or interface declaration to the generated class or interface. (Inherited from AifClassGeneratorBase.)
	addDocumentation	Adds custom code to class documentation. (Overrides the addDocumentation Method.)
	addExistsMethod	Generates the Exists method for the specified data item.
	addInterfaceDeclaration	Adds the class declaration for the interface being generated. (Inherited from AifClassGeneratorBase.)
	addNewMethod	Generates 'new' method for the strongly typed data container.
	addParmMethod	Generates the parm method for the specified data item.
	addToDeclaration	Contains changes to be made to the default class declaration, which is empty. (Inherited from AifClassGeneratorBase.)
	addVariables	Provides a location to add class variables. (Inherited from AifClassGeneratorBase.)
	buildDataItemNameMap
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	classExists	Determines whether the class to be generated already exists. (Inherited from AifClassGeneratorBase.)
	clearClass	Microsoft internal use only. (Inherited from AifClassGeneratorBase.)
	compileAndSave	Compiles and saves the newly generated class (Inherited from AifClassGeneratorBase.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	generate	Generates or regenerates the class. (Inherited from AifClassGeneratorBase.)
	getBaseAccessorNames	Retrieves the names of the base accessors.
	getDataContainerClassId
	getDataItemNameAttributeSource
	getDataItemTypeAndDefaultValueStrings	Retrieves the type and default value strings that correspond to the specified data item type.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	methodExists	Determines whether the specified method already exists. (Inherited from AifClassGeneratorBase.)
	new	Constructs an instance of this class. (Overrides the new Method.)
	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.)
	parmAllowExistingClass	Gets or sets the value of the _allowExistingClass parameter. (Inherited from AifClassGeneratorBase.)
	parmBaseClassName	Gets or sets the value of the ClassName parameter. (Inherited from AifClassGeneratorBase.)
	parmBaseInterfaceName	Gets or sets the value of the ClassName parameter. (Inherited from AifClassGeneratorBase.)
	parmClassName	Gets or sets the value of the ClassName parameter. (Inherited from AifClassGeneratorBase.)
	parmDataContainerClassMap	Gets or sets the DataContainerClassMap parameter.
	parmDataContainerType	Gets or sets the DataContainerType parameter.
	parmDataContainerTypeMacroLibName	Gets or sets the DataContainerTypeMacroLibName parameter.
	parmInterfacesImplemented	Gets or sets the current instance of the Set class. (Inherited from AifClassGeneratorBase.)
	parmIsAbstract	Gets or sets the value of the _isAbstract parameter. (Inherited from AifClassGeneratorBase.)
	parmIsInterface	Gets or sets the value of the _isInterface parameter. (Inherited from AifClassGeneratorBase.)
	parmRegenerate	Gets or sets the value of the _regenerate parameter. (Inherited from AifClassGeneratorBase.)
	parmServiceClassName	Gets or sets the ServiceClassName parameter.
	postProcess	Registers the newly generated strongly typed data container class that has the data container factory. (Overrides the postProcess Method.)
	preProcess	Microsoft internal use only. (Overrides the preProcess Method.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validateGenerationParameters	Validates generation parameters. (Overrides the validateGenerationParameters Method.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::getDataItemNameMap

Top

Remarks

This class generates strongly typed data container classes.

Examples

static void example() 
{ 
    AfDataContainerClassGenerator dataContainerClassGenerator; 
    dataContainerClassGenerator = new AfDataContainerClassGenerator(); 
    dataContainerClassGenerator.parmClassName('MyDataContainerClass'); 
    dataContainerClassGenerator.parmDataContainerType('MyDataContainerType'); 
    dataContainerClassGenerator.generate(); 
}

Inheritance Hierarchy

Object Class
  AifClassGeneratorBase Class
    AfDataContainerClassGenerator Class