SIGBaseDocument Class [AX 2012]
The SIGBaseDocument class contains the definitions (and values) for the Signature Base Document.This class can only be extended by another class.This class cannot be run by itself.
| Method | Description | |
|---|---|---|
| cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
| checkInternalIntegrity | Verifies the integrity of the signature check log. |
| compareFields | Indicates whether a field from the fields and _fieldList match. |
| equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
| fillDocumentListView | Creates a list of document fields. |
| getAuditLogRef | Retrieves the set audit trail reference. |
| getComment | Retrieves the set document comment. |
| getFields | Accesses the field list of the document. |
| getLoginId | Retrieves the set user ID. |
| getLogType | Retrieves the set databaseLog type. |
| getReasonCodeId | Retrieves the set ReasonCodeId property. |
| getRefRecId | Retrieves the set Reference Record ID. |
| getRefTableId | Retrieves the set reference table ID. |
| getSignableDocument | Retrieves information about a signable document stored in the class. |
| getSignableSigneeId | Retrieves the SigneeId value. |
| getSigneeId | Retrieves the SigneeId property. |
| getSigningProviderId | Retrieves the ProviderId property. |
| getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
| handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
| initDatabaseLog | Initiates the databaseLog record from the current record. |
| initFieldList | Initializes the object from parameter data. |
| isInsertMatch | Indicates whether all non-system fields in the fields container and _logFields parameter match for an insert function. |
| isUpdateMatch | Indicates whether all non-system fields in the fields container and _logFields parameter match for an update function. |
| new | Initializes a new instance of the SIGBaseDocument class. |
| 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.) |
| owner | Returns the instance that owns the object. (Inherited from Object.) |
| pack | Serializes the current instance of the SIGBaseDocument class. |
| parmSignature | Gets or sets the Signature parameter. |
| parmSignatureDateTime | Gets or sets the SignatureDateTime parameter. |
| parmSigningCertificateId | Gets or sets the SigningCertificateId parameter. |
| parmStorableSignatureDateTime | Gets or sets the StorableSignatureDateTime parameter. |
| parmStorableSigningCertificateId | Gets or sets the StorableSigningCertificateId parameter. |
| setAuditLogRef | Sets the auditLogRef property. |
| setComment | Sets the comment property. |
| setReasonCodeId | Sets the reasonCodeId to parameter value. |
| setRefRecId | Sets the refRecId property. |
| setSigneeId | Sets the signeeId property. |
| setSigningProviderId | Sets the signingProviderId property. |
| setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
| toString | Returns a string that represents the current object. (Inherited from Object.) |
| unpack | Deserializes the _packedclass parameter value to an instance of the SIGBaseDocument class. |
| usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
| wait | Pauses a process. (Inherited from Object.) |
| xml | Returns an XML string that represents the current object. (Inherited from Object.) |
| ::addListToCache | Adds the list of signed documents to the cache. |
| ::addToCache | Adds the current document to existing local cache or creates new local cache. |
| ::buildFieldList | Builds a list of audited fields for comparison during the insert and update functions. |
| ::buildRenameFieldList | Builds a list of fields when the primary key of a record is being changed. |
| ::checkAndCache | Check whether a signature is required based on the table and database log type. Also validates that the document is signed using a provider. |
| ::checkAndCacheList | Checks whether each document in the list requires a signature. If at least one document in the list requires a signature, the documents that require the signature will be signed and put into the cache. |
| ::checkAndCacheRename | Checks whether a rename action requires a signature. |
| ::clearAllFromCache | Clears all of the local application cache. |
| ::clearListFromCache | Clears the cache for the specified _tableId parameter from the local application cache. |
| ::contents2str | Converts contents of the _contents parameter to a string. |
| ::getChangedFields | Retrieves a list of modified fields based on the list of audit fields for the specified table. |
| ::getListFromCache | Retrieves a cached field list for the specified _tableId parameter. |
| ::isCached | Indicates whether the _fieldList parameter is the same as the list of cached fields for the specified _tableId parameter. |
| ::newDatabaseLog | Creates a new log entry in the database log. |
| ::newFieldList | Instantiates a new document from a field list, table ID, and record ID. |
| ::putListIntoCache | Inserts a field list into the local application cache without any validation. |
| ::value2str | Convert the contents of the _contents parameter to a string. |
Community Additions
ADD
Show: