MGCLatticeAsyncOperationStatusContract

Response of getAsyncOperationStatus. Success says whether the status query itself succeeded (the tracking id was valid and found); Status is the state of the asynchronous operation; when the operation failed, ErrorCode, IsRetryable and Errors carry its failure.

Methods

new

Initializes a new instance of the MGCLatticeAsyncOperationStatusContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeAsyncOperationStatusContract class.

• Visibility: public
• Returns: MGCLatticeAsyncOperationStatusContract A new MGCLatticeAsyncOperationStatusContract instance.

No parameters.

parmSuccess

True when the tracking id was valid and the operation was found; false for a malformed request or an unknown tracking id.

• Visibility: public
• Returns: boolean The current value.

Name	Type	Optional	Description
_success	boolean	Yes	The value to set.

parmTrackingId

The tracking identifier of the asynchronous operation.

• Visibility: public
• Returns: Guid The current value.

Name	Type	Optional	Description
_trackingId	Guid	Yes	The value to set.

parmStatus

The operation state: Queued, Processing, Succeeded or Failed; NotFound for an unknown tracking id; None for a malformed request.

• Visibility: public
• Returns: MGCLatticeAsyncOperationStatus The current value.

Name	Type	Optional	Description
_status	MGCLatticeAsyncOperationStatus	Yes	The value to set.

parmErrorCode

The error code of a failed operation or of a refused status query; None otherwise.

• Visibility: public
• Returns: MGCLatticeServiceErrorCode The current value.

Name	Type	Optional	Description
_errorCode	MGCLatticeServiceErrorCode	Yes	The value to set.

parmIsRetryable

Whether the failure can be retried with the same request.

• Visibility: public
• Returns: boolean The current value.

Name	Type	Optional	Description
_isRetryable	boolean	Yes	The value to set.

parmMessage

The human-readable status or result message.

• Visibility: public
• Returns: str The current value.

Name	Type	Optional	Description
_message	str	Yes	The value to set.

parmErrors

The error messages of a failed operation or of a refused status query.

• Visibility: public
• Returns: List The current value.

Name	Type	Optional	Description
_errors	List	Yes	The value to set.

parmDocumentId

The document identifier the operation reported on success.

• Visibility: public
• Returns: str The current value.

Name	Type	Optional	Description
_documentId	str	Yes	The value to set.

parmPostedDocumentId

The number of the document the operation produced (for example the posted journal); empty when none.

• Visibility: public
• Returns: str The current value.

Name	Type	Optional	Description
_postedDocumentId	str	Yes	The value to set.

parmSubmittedDateTimeUtc

The UTC time the operation was submitted.

• Visibility: public
• Returns: utcdatetime The current value.

Name	Type	Optional	Description
_submittedDateTimeUtc	utcdatetime	Yes	The value to set.

parmCompletedDateTimeUtc

The UTC time the operation reached Succeeded or Failed.

• Visibility: public
• Returns: utcdatetime The current value.

Name	Type	Optional	Description
_completedDateTimeUtc	utcdatetime	Yes	The value to set.

parmCorrelationId

The correlation identifier of the submission (echoes the query's for an unknown or malformed request).

• Visibility: public
• Returns: Guid The current value.

Name	Type	Optional	Description
_correlationId	Guid	Yes	The value to set.