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