AxInternalBase Class [AX 2012]

Article
04/11/2014

Provides the framework that is used in the AxBC table classes.

Syntax

class AxInternalBase

Run On

Called

Methods

	Method	Description
	axCurrencyCode	Converts a value that relates to currency code identification by using the map policy that is passed to the AxBC table class.
	axCustAccount	Converts a value that relates to customer accounts by using the map policy that is passed to the AxBC table class.
	axCustMarkupCode	Converts a value that relates to markup codes for customers by using the map policy that is passed to the AxBC table class.
	axDlvModeId	Converts a value that relates to delivery mode identification by using the map policy that is passed to the AxBC table class.
	axDlvTermId	Converts a value that relates to delivery term identification by using the map policy that is passed to the AxBC table class.
	axItemId	Converts an item ID by using the MapPolicy that is given for the internal class.
	axLogisticsAddressCountryRegionId
	axLogisticsAddressCountyId
	axLogisticsAddressStateId
	axLogisticsAddressZipCodeId
	axOrig	Gets the original object.
	axPurchItemId	Converts a value that relates to item identification by using the map policy that is passed to the AxBC table class when a vendor is related.
	axSalesItemId	Converts a value that relates to item identification by using the map policy that is passed to the AxBC table class when a customer is related.
	axTaxCode	This method converts tax codes by using the map policy that is specified for the class.
	axUnitOfMeasureSymbol
	axVendAccount	Converts a value that relates to customer account identification by using the map policy that is passed to the AxBC table class.
	axVendMarkupCode	Converts a value that relates to markup codes for vendors by using the map policy that is passed to the AxBC table class.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	checkNumber	Indicates whether a value is valid with regard to a number sequence table.
	classCacheDelete	Delete an object from the cache.
	classCacheExist
	classCacheInsert
	classCacheLookup
	clearField
	continueOnError	Identifies whether the code should continue when an error is found in the AxBC table class in validating the record.
	copy
	createAxbcTypeId
	createOrUpdateRelatedRecords	This method is for updating or creating records that relates to the data in the AxBC class.
	currentRecord	Gets or sets the current record in the AxBC table.
	dataSourceName
	defaulting	Identifies whether defaulting should be used in the AxBC table class.
	delete
	doModify
	doParm
	doSave	Saves or updates a record.
	emptyRecord	Returns an empty record for the table that the AxBC class relates to.
	end	Throws an error if an inventDim section was missing in an XML string.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	fieldId	Gets or sets the value for a field in the table that relates to the AxBC table class, depending on the field ID.
	getAxbcTypeId
	getEntityKey
	getFieldArraySize
	getKeyFields
	getMandatoryFieldExemptions	Retrieves the list of fields that the AxBC class has specified as not mandatory in the AxInternalBase.initMandatoryFieldsExemptionList Method.
	getModifiedFields
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	init	Initializes internal values of the current AxBC class.
	initMandatoryFieldsExemptionList
	initRecord
	inputStatus
	isFieldModified
	isFieldSet
	isFieldSetExternally
	isMethodExecuted
	isProcessed	Identifies the processing state of the record.
	isSetMethodsCalledFromModify
	isSetMethodsCalledFromSave
	isSetMethodsCalledFromUpdate
	mapPolicy	Gets or sets the AxMapPolicy class that is being used for defining the value mapping in the AxBC table framework.
	modify
	moveTableFields
	new	Initializes a new instance of the AxInternalBase class.
	nextCacheIdx
	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.)
	parentAxBC
	parm_DocumentHash	Gets or sets the _DocumentHash parameter.
	parmRecId	Gets or sets the RecId parameter.
	parmRecVersion	Gets or sets the RecVersion parameter.
	reconstruct	Resets internal values of the current AxBC class and assigns a new table buffer.
	recordAction	Identifies the action that is to be performed on the record.
	replaceCurrentRecord
	resetAxbcTypeParameters
	resetInternalValues
	save	Inserts or updates the current record for the AxBC class.
	setCurrentRecordFromExternal
	setDimensionEntitySpecifiers	Updates the financial dimension entity specifiers for the record.
	setField	Assigns a value to a field in the currentRecord that is assigned to the AxBC class.
	setFieldAsModified
	setFieldAsTouched	Sets a field as touched.
	setInventDimIdDirtySaved	Sets the value of class variable inventDimIdDirtySaved.
	setParmMethodAsNotMandatory
	setTableFields	Ensures that all default methods are called before inserting or updating a record.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	sysDictFieldFind	Finds the SysDictField class for a field in the table that relates to the AxBC class.
	tableCacheExist
	tableCacheInsert
	tableCacheLookup
	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.)
	validateField	Calls the validateField method for the current record and logs an error for validation failures.
	validateFields
	validateInboundCurrencyString	Validates the string length for an incoming currency code string.
	validateInboundItemIdString	Validates the string length for an incoming string that relates to item Id.
	validateInboundString	Validates the string length for an incoming string.
	validateInput	Identifies whether input should be validated in the AxBC table class.
	validateWrite
	valueMapDependingFields	Performs incoming value mapping of fields where the value mapping for a field depends on another field, such as the Item, state, and county fields.
	valueMappingInbound	Indicates whether the AxBC class can use value-mapping incoming.
	valueMappingOutbound	Indicates whether the AxBC class can use value mapping outgoing.
	wait	Pauses a process. (Inherited from Object.)
	write
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	xmlDocDirection
	::_isAxBcAvailable
	::addParm
	::addPrefix
	::construct	Constructs the AxBC class that relates to the specified table instance.
	::flushCache	Flushes the cache.
	::newTableId
	::parmMethods	Returns a map that contains methods with parm as the prefix in the method name for a class.
	::parmMethodsCached	Returns a map that contains methods with parm as the prefix in the method name for a class.
	::persistCache
	::stripParm	Strips the parm prefix for the string passed in the parameter.
	::stripPrefix
	::tableId2AxBCClassId	Gets the ID of the AxBC class that corresponds a particular table.

Top

Remarks

The framework that this class provides consists of methods for inserting and updating records in tables and methods that will be used for value mapping.

This class is not intended for use alone because it only provides the framework for the AxBC table classes.

The AxBC table classes have the following characteristics:

A One-to-one relationship between class and table.
The classes use the same name, with an Ax prefix, as the corresponding table. For example, the AxSalesTable class changes records in the SalesTable table.
The interface methods on the AxBC table class for fields in the related table use the same name, with a prefix of parm, as the fields on the table.For example, the parmCustAccount method on the AxSalesTable class is used externally to set or get the value of the CustAccount field in the SalesTable table.
The classes change the table records directly by setting the values of the table field and executing the update and insert methods on the table.
The default business logic is performed in the methods the methods that have a prefix of set. For example the setCurrencyCode method on the AxSalesTable class is used internally to set the value of the CurrencyCode field in the SalesTable table, depending on the value in the CustAccount field.

When you create a new AxBC table class you must override the following methods:

setTableFields
currentRecord
axOrig
emptyRecord

Also, you must override the valueMapDependingFields method if and only if you have fields in the table where the value mapping for a field is depending on another field. For example, the value mapping of a state field depends on a country or region field.

By using the AxGenerateAx<table>Class class, you can create the skeleton for a new AxBC table class. The skeleton for an AxBC table class can also be created through the Axd Wizard.

Examples

The following examples show how to create a record in Microsoft Dynamics AX and how to expose a record from Microsoft Dynamics AX by using AxBC table classes.

// Example of using an AxBC table class to insert a record in Microsoft Dynamics AX (a SalesTable record in this case). 
 
AxSalesTable   axSalesTable = new AxSalesTable(); 

axSalesTable.parmCustAccount('3000'); 
// Fill in additional parm methods. 
axSalesTable.save(); 
  
// Example of using an AxBC table class to update an existing record in Microsoft Dynamics AX by using the new<TableName> method on the Ax<TableName> class (a SalesTable record in this case). 
AxSalesTable   axSalesTable; 
SalesTable     salesTable; 

select firstonly salesTable; 
axSalesTable = AxSalesTable::newSalesTable(salesTable); 
axSalesTable.parmSalesName('New Sales Name'); 
axSalesTable.save(); 
 
// Example of using an AxBC table class to update an existing record in Microsoft Dynamics AX by using the construct method on the AxInternalBase class (a SalesTable record in this case). 
AxSalesTable   axSalesTable = new AxSalesTable(); 
SalesTable     salesTable; 

select firstonly salesTable; 
axSalesTable = AxInternalBase::construct(salesTable); 
axSalesTable.parmSalesName('New Sales Name'); 
axSalesTable.save();   
 
// Example of using an AxBC table class to read an existing record in Microsoft Dynamics AX (a SalesTable record in this case). 
AxSalesTable   axSalesTable = new AxSalesTable(); 
SalesTable     salesTable; 

select firstonly salesTable;  
axSalesTable = AxInternalBase::construct(salesTable); 
info(strfmt("First created sales order is for Customer '%1'" ,axSalesTable.parmCustAccount()));

Inheritance Hierarchy