AxdBase.getEntityKeyList Method [AX 2012]

Retrieves all entity keys that pass the server-defined document filters.

Syntax

public AifEntityKeyPage getEntityKeyList(AifDocumentPaging _documentPaging, AifEndpointActionPolicyInfo _actionPolicyInfo)

Run On

Server

Parameters

  • _actionPolicyInfo
    Type: AifEndpointActionPolicyInfo Class
    An instance of the AifEndpointActionPolicyInfo class that specifies the value mapping to perform; optional.

Return Value

Type: AifEntityKeyPage Class
A list that contains the entity keys that define the documents that are identified by the query or the array of criteria.

Remarks

The getEntityKeyList method is implemented on the AxdBase class. If a document does not provide the corresponding QueryEntityKeys action type, the getEntityKeyList method must be overridden on the document class for the getEntityKeyList method to throw an error if it is called. For an example, see the getEntityKeyList method of the AxdSalesPackingSlip class.

See Also

Reference

AxdBase Class