MGCLatticeBulkItemResultContract
Per-item result contract within a bulk operation response, carrying the item index, individual success/failure status, the affected document identifier, and any error messages for that specific item.
Methods
new
Initializes a new instance of the MGCLatticeBulkItemResultContract class.
- Visibility:
public - Returns:
void
No parameters.
construct
Creates a new instance of the MGCLatticeBulkItemResultContract class.
- Visibility:
public - Returns:
MGCLatticeBulkItemResultContractA new MGCLatticeBulkItemResultContract instance.
No parameters.
parmItemIndex
Gets or sets the one-based index of this item within the original bulk request array.
- Visibility:
public - Returns:
intThe one-based item position.
| Name | Type | Optional | Description |
|---|---|---|---|
_itemIndex | int | Yes | The one-based item position. |
parmRequestId
Gets or sets the caller-supplied request identifier for this individual item, used for idempotency.
- Visibility:
public - Returns:
GuidThe unique request GUID for this item.
| Name | Type | Optional | Description |
|---|---|---|---|
_requestId | Guid | Yes | The unique request GUID for this item. |
parmSuccess
Gets or sets whether this individual item was processed successfully.
- Visibility:
public - Returns:
booleanTrue if the item operation succeeded; otherwise, false.
| Name | Type | Optional | Description |
|---|---|---|---|
_success | boolean | Yes | True if the item operation succeeded; otherwise, false. |
parmStatus
Gets or sets the lifecycle status of this individual item (Succeeded or Failed).
- Visibility:
public - Returns:
MGCLatticeServiceCallStatusThe item lifecycle status value.
| Name | Type | Optional | Description |
|---|---|---|---|
_status | MGCLatticeServiceCallStatus | Yes | The item lifecycle status value. |
parmErrorCode
Gets or sets the machine-readable error code categorizing the failure cause for this individual item.
- Visibility:
public - Returns:
MGCLatticeServiceErrorCodeThe item error code value.
| Name | Type | Optional | Description |
|---|---|---|---|
_errorCode | MGCLatticeServiceErrorCode | Yes | The item error code value. |
parmIsRetryable
Gets or sets whether the failed operation for this individual item can be safely retried by the caller.
- Visibility:
public - Returns:
booleanTrue if the item operation is retryable; otherwise, false.
| Name | Type | Optional | Description |
|---|---|---|---|
_isRetryable | boolean | Yes | True if the item operation is retryable; otherwise, false. |
parmMessage
Gets or sets the human-readable result message for this individual item.
- Visibility:
public - Returns:
strThe item result message text.
| Name | Type | Optional | Description |
|---|---|---|---|
_message | str | Yes | The item result message text. |
parmDocumentId
Gets or sets the business document identifier produced or affected by this individual item operation.
- Visibility:
public - Returns:
strThe business document identifier for this item.
| Name | Type | Optional | Description |
|---|---|---|---|
_documentId | str | Yes | The business document identifier for this item. |
parmPostedDocumentId
Gets or sets the number of the document this item produced (invoice, packing slip, confirmation, journal or created order); empty when the item produced no numbered document.
- Visibility:
public - Returns:
strThe produced document number.
| Name | Type | Optional | Description |
|---|---|---|---|
_postedDocumentId | str | Yes | The produced document number. |
parmErrors
Gets or sets the collection of error messages specific to this individual item.
- Visibility:
public - Returns:
ListThe item-level error messages list.
| Name | Type | Optional | Description |
|---|---|---|---|
_errors | List | Yes | The item-level error messages list. |