Share via


AxdProjectDocument Class [AX 2012]

The AxdProjectDocument class encapsulates the logic for performing operations on ProjTable table to be used by the ProjectService class.

Syntax

class AxdProjectDocument extends AxdBase

Run On

Server

Methods

  Method Description
Dn515680.pubmethod(en-us,AX.60).gif afterDeserializeEntity Called for each record after is has been deserialized. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Dn515680.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. (Inherited from AxdBase.)
Dn515680.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. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif createEntityKey (Inherited from AxdBase.)
Dn515680.protmethod(en-us,AX.60).gif createEntityKeyFieldList (Inherited from AxdBase.)
Dn515680.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. (Inherited from AxdBase.)
Dn515680.protmethod(en-us,AX.60).gif createNewQuery (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif defaultValidTimeState (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif deleteList Deletes an AiFEntityKeyList. (Overrides the deleteList Method.)
Dn515680.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Dn515680.pubmethod(en-us,AX.60).gif expandDimensions Determines if project dimension fields are exposed as dimension values instead of a record ID. (Overrides the expandDimensions Method.)
Dn515680.pubmethod(en-us,AX.60).gif expandSurrogateForeignKeys Determines if surrogate key references will be replaced by fields from the natural key of the target table. (Overrides the expandSurrogateForeignKeys Method.)
Dn515680.pubmethod(en-us,AX.60).gif findCorrespondingAxBC Finds the AxBC class that is used for the specified table in the document service. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif findEntityKeyList Finds entity keys that identify posted transactions in the database. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif findList Finds posted transactions from the database, and then writes them to an XML string. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getActionList Gets a list of all possible actions for the particular Axd document. (Overrides the getActionList Method.)
Dn515680.pubmethod(en-us,AX.60).gif getAdditionalMandatoryFieldsMap (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getChangedEntityKeyList Retrieves all entity keys that pass the server-defined document filters. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getConstraintList Identifies the constraint(s) from a particular record. (Overrides the getConstraintList Method.)
Dn515680.protmethod(en-us,AX.60).gif getCurrentDateTime (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getDataSourceCardinality (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getDataSourceFieldSet Gets a set that contains the field names in a QueryBuildDataSource class. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getDataSourceNameForEntityKey (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getDimensionId Translates the dimension value from the xml document into a dimension ID. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getDocumentTypeId Microsoft internal use only. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getEnhancedSchema Gets the enhanced XML Schema Document (XSD) of the Axd document. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getEntityKeyFieldList Gets the fields that will be used in the entity key. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getEntityKeyList Retrieves all entity keys that pass the server-defined document filters. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getEntityKeyReplacementElementMap (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getEntityKeySfkOptionalFieldsMap This method is for internal use only.Gets the optional SFK fields map for the entity key. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getFieldAccessOverRides (Inherited from AxdBase.)
Dn515680.protmethod(en-us,AX.60).gif getKeyFields (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getLabel Returns the label that corresponds to the localized document name. (Overrides the getLabel Method.)
Dn515680.pubmethod(en-us,AX.60).gif getName Returns a fixed string that contains the name of the document. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getNamespace Returns a fixed string that contains the namespace of the document. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getQuery Fetches the instance of the query that corresponds to the Axd document class. (Inherited from AxdBase.)
Dn515680.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. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getSchema Gets the XSD of the Axd document. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getSfkReplacementMap (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getSharedTypesSchema (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getSharedTypesSchemaXml (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getSurrogateForeignKeyValue Translates the surrogate foreign key replacement value from the xml document into a surrogate foreign key value. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getTableIdForEntityKey Gets the table ID that will be used in the entity key. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Dn515680.protmethod(en-us,AX.60).gif getValidTimeStateDateTime (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getValidTimeStateFieldType (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif getXmlDataSourceNames (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Dn515680.protmethod(en-us,AX.60).gif initFieldAccessOverrides (Inherited from AxdBase.)
Dn515680.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. (Inherited from AxdBase.)
Dn515680.protmethod(en-us,AX.60).gif initNewQuery (Inherited from AxdBase.)
Dn515680.protmethod(en-us,AX.60).gif initQuery (Inherited from AxdBase.)
Dn515680.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. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif initQueryFromQuery Initializes the query associated with the document based on the criteria values supplied. (Inherited from AxdBase.)
Dn515680.protmethod(en-us,AX.60).gif initQueryValidTimeState Initialize the valid time state for the Axd query (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif isExpandableDimensionEDT (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif isExpandableSurrogateForeignKey (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif isFieldEditable (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif isFieldVisible Determines if a field is visible. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif isValidTimeStateDocument (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif mergeFilters (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif mergeRanges (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif new Initializes a new instance of the AxdBase class. (Inherited from AxdBase.)
Dn515680.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.)
Dn515680.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.)
Dn515680.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Dn515680.protmethod(en-us,AX.60).gif overRideFieldAccess (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Dn515680.pubmethod(en-us,AX.60).gif parmClearNilFieldsOnUpdate Gets or sets the ClearNilFieldsOnUpdate parameter. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif parmDocPurpose Gets or sets the DocPurpose parameter. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif parmSenderId Gets or sets the SenderId parameter. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif parmValidAsOfDateTime Gets or sets the ValidAsOfDateTime parameter. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif parmValidFromDateTime Gets or sets the ValidFromDateTime parameter. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif parmValidTimeStateType Gets or sets the ValidTimeStateType parameter. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif parmValidToDateTime Gets or sets the ValidToDateTime parameter. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif prepareForDelete Prepares an AxBC class to be deleted. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif prepareForDeleteExtended Prepares an AxBC class to be deleted. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif prepareForQuery Prepares a query before executing the query. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif prepareForSave Prepares an AxBC class to be saved. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif prepareForSaveExtended Prepares an AxBC class to be saved. (Overrides the prepareForSaveExtended Method.)
Dn515680.pubmethod(en-us,AX.60).gif prepareForUpdate Prepares an AxBC class to be updated. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif prepareForUpdateExtended Prepares an AxBC class to be updated. (Overrides the prepareForUpdateExtended Method.)
Dn515680.pubmethod(en-us,AX.60).gif processingRecord Called for each record processed during read and create. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif read Reads a posted transaction from the database and writes it to an XML string. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif readList Reads posted transactions from the database and writes them to an XML string. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif security Identifies whether security should be used in the Axd class. (Inherited from AxdBase.)
Dn515680.protmethod(en-us,AX.60).gif setAifFaultContext (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif setParmMethodAsMandatory Sets the field specified by a parm method as mandatory in the schema and XML. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif setSharedTypesSchema (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif setTableFieldAsMandatory Specifies that the field should be mandatory in the schema and in the XML. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Dn515680.pubmethod(en-us,AX.60).gif skipSecurityChecks (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif topRecordAction (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Dn515680.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). (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif update (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif updateList (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif updateNow Makes document-specific updates when it processes an incoming document. (Inherited from AxdBase.)
Dn515680.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.)
Dn515680.protmethod(en-us,AX.60).gif useNaturalEntityKey (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif validateDocument Validates that any business rules that govern the processing of the Axd document are complied with. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif validateEntityKey Validates whether an entity key that is passed to Axd framework is valid. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif validateEntityKeyFieldAccess (Inherited from AxdBase.)
Dn515680.protmethod(en-us,AX.60).gif validateTableId Validates that the table ID in a common object matches a specific table ID. (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif validateValidTimeState (Inherited from AxdBase.)
Dn515680.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Dn515680.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)

Top

Inheritance Hierarchy

Object Class
  AxdBase Class
    AxdProjectDocument Class