AxdBase Class [AX 2012]

Combines queries, table objects (Ax <table> classes), and XML code to provide an XML framework for Microsoft Dynamics AX.

class AxdBase implements AifServiceable

Run On

Server

  MethodDescription
Gg830851.pubmethod(en-us,AX.60).gif afterDeserializeEntity Called for each record after is has been deserialized.
Gg830851.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg830851.pubmethod(en-us,AX.60).gif checkInventDim Validates the document class for the inventory dimension to be created as part of the current service invoked.
Gg830851.pubmethod(en-us,AX.60).gif create Creates the document in the XML string as a transaction in the database tables, and then returns the entity key of the created transaction.
Gg830851.privmethod(en-us,AX.60).gif createAxdBaseReadInstance
Gg830851.pubmethod(en-us,AX.60).gif createEntityKey
Gg830851.protmethod(en-us,AX.60).gif createEntityKeyFieldList
Gg830851.pubmethod(en-us,AX.60).gif createList Creates the documents in the XML string as transactions in the database, and then returns the entity keys of the created transactions.
Gg830851.protmethod(en-us,AX.60).gif createNewQuery
Gg830851.pubmethod(en-us,AX.60).gif defaultValidTimeState
Gg830851.pubmethod(en-us,AX.60).gif deleteList
Gg830851.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg830851.pubmethod(en-us,AX.60).gif expandDimensions
Gg830851.pubmethod(en-us,AX.60).gif expandSurrogateForeignKeys
Gg830851.pubmethod(en-us,AX.60).gif findCorrespondingAxBC Finds the AxBC class that is used for the specified table in the document service.
Gg830851.pubmethod(en-us,AX.60).gif findEntityKeyList Finds entity keys that identify posted transactions in the database.
Gg830851.pubmethod(en-us,AX.60).gif findList Finds posted transactions from the database, and then writes them to an XML string.
Gg830851.pubmethod(en-us,AX.60).gif getActionList Gets a list of all possible actions for the particular Axd document.
Gg830851.pubmethod(en-us,AX.60).gif getAdditionalMandatoryFieldsMap
Gg830851.pubmethod(en-us,AX.60).gif getChangedEntityKeyList Retrieves all entity keys that pass the server-defined document filters.
Gg830851.pubmethod(en-us,AX.60).gif getConstraintList Identifies the constraint(s) from a particular record.
Gg830851.protmethod(en-us,AX.60).gif getCurrentDateTime
Gg830851.pubmethod(en-us,AX.60).gif getDataSourceCardinality
Gg830851.pubmethod(en-us,AX.60).gif getDataSourceFieldSet Gets a set that contains the field names in a QueryBuildDataSource class.
Gg830851.pubmethod(en-us,AX.60).gif getDataSourceNameForEntityKey
Gg830851.pubmethod(en-us,AX.60).gif getDimensionId Translates the dimension value from the xml document into a dimension ID.
Gg830851.pubmethod(en-us,AX.60).gif getDocumentTypeId Microsoft internal use only.
Gg830851.pubmethod(en-us,AX.60).gif getEnhancedSchema Gets the enhanced XML Schema Document (XSD) of the Axd document.
Gg830851.pubmethod(en-us,AX.60).gif getEntityKeyFieldList Gets the fields that will be used in the entity key.
Gg830851.pubmethod(en-us,AX.60).gif getEntityKeyList Retrieves all entity keys that pass the server-defined document filters.
Gg830851.privmethod(en-us,AX.60).gif getEntityKeyListInternal
Gg830851.pubmethod(en-us,AX.60).gif getEntityKeyReplacementElementMap
Gg830851.privmethod(en-us,AX.60).gif getEntityKeyReplacementElementValueMap
Gg830851.pubmethod(en-us,AX.60).gif getEntityKeySfkOptionalFieldsMap This method is for internal use only.Gets the optional SFK fields map for the entity key.
Gg830851.pubmethod(en-us,AX.60).gif getFieldAccessOverRides
Gg830851.protmethod(en-us,AX.60).gif getKeyFields
Gg830851.pubmethod(en-us,AX.60).gif getLabel Returns the label that corresponds to the localized document name.
Gg830851.pubmethod(en-us,AX.60).gif getName Returns a fixed string that contains the name of the document.
Gg830851.pubmethod(en-us,AX.60).gif getNamespace Returns a fixed string that contains the namespace of the document.
Gg830851.pubmethod(en-us,AX.60).gif getQuery Fetches the instance of the query that corresponds to the Axd document class.
Gg830851.pubmethod(en-us,AX.60).gif getQueryName Returns the name of the query that will be used. For example, the query that corresponds to the Axd document.
Gg830851.privmethod(en-us,AX.60).gif getQueryValueForCriteriaElement
Gg830851.pubmethod(en-us,AX.60).gif getSchema Gets the XSD of the Axd document.
Gg830851.privmethod(en-us,AX.60).gif getSchemaInternal
Gg830851.privmethod(en-us,AX.60).gif getSfkReplacementElement
Gg830851.pubmethod(en-us,AX.60).gif getSfkReplacementMap
Gg830851.pubmethod(en-us,AX.60).gif getSharedTypesSchema
Gg830851.pubmethod(en-us,AX.60).gif getSharedTypesSchemaXml
Gg830851.pubmethod(en-us,AX.60).gif getSurrogateForeignKeyValue Translates the surrogate foreign key replacement value from the xml document into a surrogate foreign key value.
Gg830851.pubmethod(en-us,AX.60).gif getTableIdForEntityKey Gets the table ID that will be used in the entity key.
Gg830851.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg830851.protmethod(en-us,AX.60).gif getValidTimeStateDateTime
Gg830851.pubmethod(en-us,AX.60).gif getValidTimeStateFieldType
Gg830851.pubmethod(en-us,AX.60).gif getXmlDataSourceNames
Gg830851.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg830851.privmethod(en-us,AX.60).gif initEntityKeyMetadata
Gg830851.protmethod(en-us,AX.60).gif initFieldAccessOverrides
Gg830851.protmethod(en-us,AX.60).gif initMandatoryFieldsMap Creates a list of mandatory fields that are specific to the document. The document must override this method to add mandatory fields that are not mandatory in the data model.
Gg830851.protmethod(en-us,AX.60).gif initNewQuery
Gg830851.protmethod(en-us,AX.60).gif initQuery
Gg830851.pubmethod(en-us,AX.60).gif initQueryFromEntityKey Instantiates the query associated with the Axd document and stores it in a variable on the AxdBase class.
Gg830851.pubmethod(en-us,AX.60).gif initQueryFromQuery Initializes the query associated with the document based on the criteria values supplied.
Gg830851.protmethod(en-us,AX.60).gif initQueryValidTimeState Initialize the valid time state for the Axd query
Gg830851.privmethod(en-us,AX.60).gif initSecurityFlags
Gg830851.pubmethod(en-us,AX.60).gif isExpandableDimensionEDT
Gg830851.pubmethod(en-us,AX.60).gif isExpandableSurrogateForeignKey
Gg830851.pubmethod(en-us,AX.60).gif isFieldEditable
Gg830851.pubmethod(en-us,AX.60).gif isFieldVisible Determines if a field is visible.
Gg830851.privmethod(en-us,AX.60).gif isFieldVisibleToUser
Gg830851.pubmethod(en-us,AX.60).gif isValidTimeStateDocument
Gg830851.pubmethod(en-us,AX.60).gif mergeFilters
Gg830851.pubmethod(en-us,AX.60).gif mergeRanges
Gg830851.pubmethod(en-us,AX.60).gif new Initializes a new instance of the AxdBase class.
Gg830851.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg830851.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg830851.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg830851.protmethod(en-us,AX.60).gif overRideFieldAccess
Gg830851.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg830851.pubmethod(en-us,AX.60).gif parmClearNilFieldsOnUpdate Gets or sets the ClearNilFieldsOnUpdate parameter.
Gg830851.pubmethod(en-us,AX.60).gif parmDocPurpose Gets or sets the DocPurpose parameter.
Gg830851.pubmethod(en-us,AX.60).gif parmSenderId Gets or sets the SenderId parameter.
Gg830851.pubmethod(en-us,AX.60).gif parmValidAsOfDateTime Gets or sets the ValidAsOfDateTime parameter.
Gg830851.pubmethod(en-us,AX.60).gif parmValidFromDateTime Gets or sets the ValidFromDateTime parameter.
Gg830851.pubmethod(en-us,AX.60).gif parmValidTimeStateType Gets or sets the ValidTimeStateType parameter.
Gg830851.pubmethod(en-us,AX.60).gif parmValidToDateTime Gets or sets the ValidToDateTime parameter.
Gg830851.pubmethod(en-us,AX.60).gif prepareForDelete Prepares an AxBC class to be deleted.
Gg830851.pubmethod(en-us,AX.60).gif prepareForDeleteExtended Prepares an AxBC class to be deleted.
Gg830851.pubmethod(en-us,AX.60).gif prepareForQuery Prepares a query before executing the query.
Gg830851.pubmethod(en-us,AX.60).gif prepareForSave Prepares an AxBC class to be saved.
Gg830851.pubmethod(en-us,AX.60).gif prepareForSaveExtended Prepares an AxBC class to be saved.
Gg830851.pubmethod(en-us,AX.60).gif prepareForUpdate Prepares an AxBC class to be updated.
Gg830851.pubmethod(en-us,AX.60).gif prepareForUpdateExtended Prepares an AxBC class to be updated.
Gg830851.pubmethod(en-us,AX.60).gif processingRecord Called for each record processed during read and create.
Gg830851.pubmethod(en-us,AX.60).gif read Reads a posted transaction from the database and writes it to an XML string.
Gg830851.pubmethod(en-us,AX.60).gif readList Reads posted transactions from the database and writes them to an XML string.
Gg830851.pubmethod(en-us,AX.60).gif security Identifies whether security should be used in the Axd class.
Gg830851.protmethod(en-us,AX.60).gif setAifFaultContext
Gg830851.privmethod(en-us,AX.60).gif setFieldAsMandatory Updates the internal list of mandatory fields.
Gg830851.pubmethod(en-us,AX.60).gif setParmMethodAsMandatory Sets the field specified by a parm method as mandatory in the schema and XML.
Gg830851.pubmethod(en-us,AX.60).gif setSharedTypesSchema
Gg830851.pubmethod(en-us,AX.60).gif setTableFieldAsMandatory Specifies that the field should be mandatory in the schema and in the XML.
Gg830851.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg830851.pubmethod(en-us,AX.60).gif skipSecurityChecks
Gg830851.pubmethod(en-us,AX.60).gif topRecordAction
Gg830851.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg830851.privmethod(en-us,AX.60).gif trimEntityKeyReplacementMap
Gg830851.protmethod(en-us,AX.60).gif unpackPropertyBag Unpacks the docPurpose property from an instance of the aifPropertyBag extended data type (if relevant for the particular Axd document).
Gg830851.pubmethod(en-us,AX.60).gif update
Gg830851.pubmethod(en-us,AX.60).gif updateList
Gg830851.pubmethod(en-us,AX.60).gif updateNow Makes document-specific updates when it processes an incoming document.
Gg830851.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg830851.protmethod(en-us,AX.60).gif useNaturalEntityKey
Gg830851.pubmethod(en-us,AX.60).gif validateDocument Validates that any business rules that govern the processing of the Axd document are complied with.
Gg830851.pubmethod(en-us,AX.60).gif validateEntityKey Validates whether an entity key that is passed to Axd framework is valid.
Gg830851.pubmethod(en-us,AX.60).gif validateEntityKeyFieldAccess
Gg830851.protmethod(en-us,AX.60).gif validateTableId Validates that the table ID in a common object matches a specific table ID.
Gg830851.pubmethod(en-us,AX.60).gif validateValidTimeState
Gg830851.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg830851.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
Gg830851.privmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::addInnerJoinedDS
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::addPrefix
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::fieldsInDataSourceSet Returns a set with the fields in a data source if the dynamic property for the fields in the data source is set to No.
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::flushCache Flushes the cache.
Gg830851.protmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::getAllowedDSForCriteria
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::getAllowedFieldsForDataSource
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::getAllowedTablesForDataSource
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::getDocumentClassIdList Returns a list of class IDs that identify the document classes in Microsoft Dynamics AX.
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::getTableFieldSet Returns a Set that contains the field names in a table.
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::getTableInheritanceChain
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::getTableInheritanceHierarchy
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::getValidTimeStateParmMethods
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::hasPrefix
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::isDataSourceInXsd
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::isDerivedTable
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::isValidReturnType Indicates whether a type is a valid type for a field in an Axd document.
Gg830851.privmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::mergeExistsJoinDataSources
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::newClassId Instantiates a document class object.
Gg830851.pubmethod(en-us,AX.60).gif Gg830851.static(en-us,AX.60).gif ::stripPrefix Removes the Axd prefix from a name.
Top

The AxdBase class provides the framework that is used in the Microsoft Dynamics AX document (Axd) classes, and is not intended to be used alone. The AxdBase class implements the AifServiceable Interface.

Calculated fields and display fields must not be made mandatory (required elements in the XML) because it is not possible to ensure that these fields do not return nullNothingnullptrunita null reference (Nothing in Visual Basic) values. The nullNothingnullptrunita null reference (Nothing in Visual Basic) values are not transferred to XML.

The core methods of the Axd documents are as follows:

The core methods are implemented on the AxdBase class.

Axd classes are used by the Application Integration Framework (AIF) to generate XSDs, convert documents (transactions) to XML, and create documents (transactions) from XML. All Axd classes inherit from the AxdBase class.

When creating a new Axd class, the following methods must be overridden:

Implement document-specific business logic by overriding the following methods:

The following methods must be overridden for the method to throw an error if the specific Axd class does not provide the corresponding action type for the method:

The following list of examples shows the code for using the core methods on the AxdBase class. The topic of each method has a more complete example.

    // How to generate XSDs. 
    axdPurchaseRequisition = AxdBase::newClassId( 
        classNum(AxdPurchaseRequisition)); 
    aifDocumentSchemaXml = axdPurchaseRequisition.getSchema(); 
  
    // How to read a single purchase requisition. 
    axdPurchaseRequisition = AxdBase::newClassId( 
        classNum(AxdPurchaseRequisition)); 
    aifDocumentXml = axdPurchaseRequisition.read( 
        aifEntityKey,  
        aifSchemaInfo,  
        aifEndpointActionPolicyInfo,  
        aifConstraintList,  
        aifPropertyBag); 
  
    // How to read a list of purchase requisitions. 
    axdPurchaseRequisition = AxdBase::newClassId( 
        classNum(AxdPurchaseRequisition)); 
    aifDocumentXml = axdPurchaseRequisition.readList( 
        aifEntityKeyList,  
        aifSchemaInfo,  
        aifEndpointActionPolicyInfo,  
        aifConstraintListCollection,  
        aifPropertyBag); 
  
    // How to find a list of purchase requisitions. 
    axdPurchaseRequisition = AxdBase::newClassId( 
        classNum(AxdPurchaseRequisition)); 
    aifDocumentXml = axdPurchaseRequisition.findList( 
        aifQueryCriteria,  
        aifSchemaInfo,  
        aifEndpointActionPolicyInfo,  
        aifConstraintListCollection, aifPropertyBag); 
  
    // How to find a list of entity keys for purchase requisitions. 
    axdPurchaseRequisition = AxdBase::newClassId( 
        classNum(AxdPurchaseRequisition)); 
    aifDocumentXml = axdPurchaseRequisition.findEntityKeyList( 
        aifQueryCriteria,  
        aifEndpointActionPolicyInfo); 
  
    // How to create a single sales order. 
    axdSalesOrder = AxdBase::newClassId(classNum(AxdSalesOrder)); 
    aifEntityKey = axdSalesOrder.create( 
        aifDocumentXml,  
        aifEndpointActionPolicyInfo,  
        aifConstraintList); 
  
    // How to create a list of sales orders. 
    axdSalesOrder = AxdBase::newClassId(classNum(AxdSalesOrder)); 
    aifEntityKeyList = axdSalesOrder.createList( 
        aifDocumentXml,  
        aifEndpointActionPolicyInfo,  
        aifConstraintListCollection);

Object Class
  AxdBase Class
    AxdAddress Class
    AxdAdvancedLedgerEntry Class
    AxdASN Class
    AxdAssetCondition Class
    AxdAssetDepRateExpImp_JP Class
    AxdAssetGroup Class
    AxdAssetLocation Class
    AxdAssetMajorType Class
    AxdAssetUndepBalanceExpImp_JP Class
    AxdBankPositivePay Class
    AxdBankStmt Class
    AxdBankStmtISO Class
    AxdBillsOfMaterials Class
    AxdBudgetPlan Class
    AxdBudgetPlanOfficeAddin Class
    AxdBudgetTransaction Class
    AxdCaseCategoryDetail Class
    AxdCaseWebDetail Class
    AxdCashDisc Class
    AxdCatImp Class
    AxdConnCustomerOrg Class
    AxdConnEmployees Class
    AxdConnExchRate Class
    AxdConnInvoice Class
    AxdConnItemSvc Class
    AxdContactPersons Class
    AxdCountingJournal Class
    AxdCustCreditCard Class
    AxdCustECollectionLetter_NO Class
    AxdCustomer Class
    AxdCustomerQuotation Class
    AxdCustomerTransaction Class
    AxdCustPayments Class
    AxdCustPaymJournal Class
    AxdDeliveryModes Class
    AxdDlvDlvMode Class
    AxdDlvDlvTerm Class
    AxdDMFExeStatus Class
    AxdDMFProcessGrp Class
    AxdEcoResCategoryDoc Class
    AxdEcoResCategoryDocument Class
    AxdEcoResProduct Class
    AxdEcoResProductMasterDimValue Class
    AxdEMSMeterReadingFlow Class
    AxdEMSSubstanceFlow Class
    AxdEUSLReporting Class
    AxdExpense Class
    AxdFixedAsset Class
    AxdFreeTextInvoice Class
    AxdGenericDocument Class
    AxdHcmJobApplication Class
    AxdHcmJobPosting Class
    AxdHcmWorkerImport Class
    AxdHRMAbsenceReq Class
    AxdIntrastatReport Class
    AxdInventDimCombination Class
    AxdInventItemBarcode Class
    AxdInventItemGroup Class
    AxdInventItemLocation Class
    AxdInventLocation Class
    AxdInventoryOnhand Class
    AxdInventoryTransactions Class
    AxdItem Class
    AxdLedgerCurrency Class
    AxdLedgerExchangeRate Class
    AxdLedgerExchangeRateType Class
    AxdLedgerGeneralJournal Class
    AxdLineDiscount Class
    AxdLogisticsAddressZipCodeSetup Class
    AxdMarkupMarkupTable Class
    AxdPaymentTerms Class
    AxdPayrollEarningsImport Class
    AxdPayrollPositivePay Class
    AxdPickingList Class
    AxdPriceDiscAdmTransDoc Class
    AxdPriceDiscountJournal Class
    AxdPricelist Class
    AxdProdPickingList Class
    AxdProfitLossJournal Class
    AxdProjCategory Class
    AxdProjContract Class
    AxdProjectDocument Class
    AxdProjectHourJournal Class
    AxdProjInformation Class
    AxdProjInvoice Class
    AxdProjQuotation Class
    AxdProjQuotationLine Class
    AxdProjWBS Class
    AxdPurchaseInvoice Class
    AxdPurchaseRequisition Class
    AxdPurchReqImport Class
    AxdPurchRFQPaymTerms Class
    AxdPurchRFQSites Class
    AxdPurchRFQUnit Class
    AxdRetailCampaignMedia Class
    AxdRetailCatAttrib Class
    AxdRetailMachine Class
    AxdRetailProductData Class
    AxdRetailStores Class
    AxdReturnOrderIn Class
    AxdReturnOrderOut Class
    AxdRFQReply Class
    AxdRFQSend Class
    AxdRouteCard Class
    AxdRoutes Class
    AxdSalesConfirmation Class
    AxdSalesInvoice Class
    AxdSalesInvoice_Einvoice Class
    AxdSalesMultilineDiscount Class
    AxdSalesOrder Class
    AxdSalesPackingSlip Class
    AxdSalesQuotation Class
    AxdSalesTotalDiscount Class
    AxdServiceAgreement Class
    AxdServiceOrder Class
    AxdsmmBusRel Class
    AxdsmmLeadPriorities Class
    AxdsmmLeads Class
    AxdSysImportBusSectors Class
    AxdTaxCodes Class
    AxdTaxExportLinesForAIF_CN Class
    AxdTaxGroups Class
    AxdTaxImportLinesForAIF_CN Class
    AxdTaxIntgrExportDocData_CN Class
    AxdTaxItemGroups Class
    AxdTMSInvoice Class
    AxdTMSPurchOrder Class
    AxdTMSTransStatus Class
    AxdTMSTransTender Class
    AxdTransferJournal Class
    AxdTransferOrder Class
    AxdTransferOrderCreate Class
    AxdTransferOrderPosting Class
    AxdTrvPBSMaindata Class
    AxdUnit Class
    AxdUnitConversion Class
    AxdVendGroup Class
    AxdVendInvoice Class
    AxdVendorPayment Class
    AxdVendPayments Class
    AxdVendTable Class
    AxdVendVendRequestSignup Class
    AxdWHSShipmentASN Class

Community Additions

ADD
Show: