AifGenericDocumentService Class [AX 2012]

  • Article

The AifDocumentService class provides a basic implementation of a customizable entity service.

Syntax

class AifGenericDocumentService extends AifDocumentService

Run On

Server

Methods

  Method Description
Gg740566.pubmethod(en-us,AX.60).gif cacheQuery
Gg740566.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg740566.pubmethod(en-us,AX.60).gif create
Gg740566.privmethod(en-us,AX.60).gif createGenericDocumentInstanceForQuery
Gg740566.privmethod(en-us,AX.60).gif createGenericDocumentInstanceForQueryId
Gg740566.protmethod(en-us,AX.60).gif createList Creates a list of entities and retrieves a list of entity keys. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif createUsingCachedQuery
Gg740566.pubmethod(en-us,AX.60).gif delete
Gg740566.pubmethod(en-us,AX.60).gif deleteCachedQuery
Gg740566.protmethod(en-us,AX.60).gif deleteList Deletes a list of entities (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif deleteUsingCachedQuery
Gg740566.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg740566.pubmethod(en-us,AX.60).gif find
Gg740566.protmethod(en-us,AX.60).gif findKeyList Find entities matching a criteria. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif findKeys
Gg740566.pubmethod(en-us,AX.60).gif findKeysUsingCachedQuery
Gg740566.protmethod(en-us,AX.60).gif findList Finds entities that match a criteria. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif findUsingCachedQuery
Gg740566.protmethod(en-us,AX.60).gif getChangedKeyList Gets entities that match server-defined criteria and are changed on or after a specified date and time. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif getConstraints Gets the constraints for the last operation. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif getCorrelationEntityKeys Gets the entity keys that relate with the last message. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif getDisplayMenuItemName Gets the command name of the configuration form. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif getDocumentKeyFields
Gg740566.privmethod(en-us,AX.60).gif getDocumentSchemas
Gg740566.protmethod(en-us,AX.60).gif getEndpointActionPolicy (Overrides the getEndpointActionPolicy Method.)
Gg740566.protmethod(en-us,AX.60).gif getKeyList Gets all entities that match server-defined criteria. (Inherited from AifDocumentService.)
Gg740566.protmethod(en-us,AX.60).gif getOperationContext Retrieves the current operation context. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif getQuery
Gg740566.pubmethod(en-us,AX.60).gif getSchemas
Gg740566.protmethod(en-us,AX.60).gif getSendParameters Gets the send parameters for a send call. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg740566.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg740566.privmethod(en-us,AX.60).gif initGenericDocumentXml
Gg740566.protmethod(en-us,AX.60).gif new Initializes a new instance of the AifGenericDocumentService class. (Overrides the new Method.)
Gg740566.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.)
Gg740566.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.)
Gg740566.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg740566.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg740566.pubmethod(en-us,AX.60).gif read
Gg740566.protmethod(en-us,AX.60).gif readList Reads a list of entities. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif readUsingCachedQuery
Gg740566.protmethod(en-us,AX.60).gif setAifFaultContext (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif setOperationContext Sets the operation context for the next operation. (Inherited from AifDocumentService.)
Gg740566.protmethod(en-us,AX.60).gif setSendParameters Sets the send parameters for a send call. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg740566.protmethod(en-us,AX.60).gif setValidTimeState (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg740566.pubmethod(en-us,AX.60).gif update
Gg740566.protmethod(en-us,AX.60).gif updateList Updates a list of entities. (Inherited from AifDocumentService.)
Gg740566.pubmethod(en-us,AX.60).gif updateUsingCachedQuery
Gg740566.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.)
Gg740566.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg740566.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
Gg740566.pubmethod(en-us,AX.60).gif Gg740566.static(en-us,AX.60).gif ::construct Initializes a new instance of the AifGenericDocumentService class.

Top

Remarks

Services generated by using the Axd wizard are derived from the AifDocumentService class. Derived classes can delegate basic entity operations to this class. This is a base class for all entity service classes.

Inheritance Hierarchy

Object Class
  AifDocumentService Class
    AifGenericDocumentService Class