AxdBase.readList Method [AX 2012]

Article
04/11/2014

Reads posted transactions from the database and writes them to an XML string.

Syntax

public AifDocumentXml readList(
    AifEntityKeyList _entityKeyList, 
    AifSchemaInfo _xsdInfo, 
    AifEndpointActionPolicyInfo _actionPolicyInfo, 
    AifConstraintListCollection _constraintListCollection, 
    AifPropertyBag _aifPropertyBag)

Run On

Server

Parameters

_entityKeyList
Type: AifEntityKeyList Class
A list of entity keys that identify the transactions to be read.

_xsdInfo
Type: AifSchemaInfo Class
An instance of the AifSchemaInfo Class, where it is possible to specify the XSD schema to use for filtering.

_actionPolicyInfo
Type: AifEndpointActionPolicyInfo Class
An instance of the AifEndpointActionPolicyInfo Class, to specify the value mapping to perform. This class can be empty if no value mapping is to occur.

_constraintListCollection
Type: AifConstraintListCollection Class
A collection of lists that contain the constraints that are identified for each document.
The _constraintListCollection parameter must be an instantiated, empty AifConstraintListCollection Class. It will be populated when the readList method is run.

_aifPropertyBag
Type: AifPropertyBag Extended Data Type
An instance of the AifPropertyBag Extended Data Type that contains an XMLDocPurpose Enumeration. The XMLDocPurpose Enumeration specifies whether the document is an original, a duplicate, a pro forma, or a snapshot.

Return Value

Type: AifDocumentXml Extended Data Type
An XML string that contains the data of the transaction.

Remarks

The readList method is implemented on the AxdBase Class. If a document does not provide the corresponding action type (SendDocumentList), the readList method. It must be overridden on the document class for this method to throw an error if called. For example, AxdSalesPackingSlip.readList.

Examples

The following example shows how to read all purchase requisitions in Microsoft Dynamics AX into an XML string.

    AxdBase                     axdBase = 
  AxdBase::newClassId(classnum(AxdPurchaseRequisition)); 
    AifEntityKey                aifEntityKey; 
    AifEntityKeyList            aifEntityKeyList =  
  AifEntityKeyList::construct(); 
    Map                         keyData; 
    VendPurchOrderJour          vendPurchOrderJour; 
    AifDocumentXml              xml; 
    AifSchemaInfo               xsdInfo; 
    AifEndpointActionPolicyInfo actionPolicyInfo = new  
  AifEndpointActionPolicyInfo(); 
    AifConstraintListCollection constraintListCollection = new   
  AifConstraintListCollection(); 
    AifPropertyBag              propertyBag; 
 
    while select vendPurchOrderJour 
    { 
        // Create Key Data. 
        keyData = SysDictTable::getKeyData(vendPurchOrderJour); 
 
        // Create Entity Key. 
        aifEntityKey = AifEntityKey::construct(); 
        aifEntityKey.parmKeyDataMap(keyData); 
 
        aifEntityKeyList.addEntityKey(aifEntityKey); 
    } 
 
    propertyBag = [XMLDocPurpose::Proforma]; 
    xml = axdBase.readList(aifEntityKeyList, xsdInfo, actionPolicyInfo,  
  constraintListCollection, propertyBag);