MGCLatticeSetSalesPriceResult

Result contract for a sales-price trade agreement create/post. Carries a success/message envelope with the machine-readable ErrorCode and the failure reasons (Errors), the echoed CorrelationId, the outcome as both its MGCLatticeTradeAgreementOutcome value and its name, the price/discount journal the agreement was posted under, the created and superseded PriceDiscTable RecIds, the new to-date stamped on a superseded row (forward-only supersession), and the effective date range and unit price actually applied.

Methods

parmSuccess

Gets or sets a value indicating whether the operation completed successfully.

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

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

parmMessage

Gets or sets a human-readable message (an error description when Success is false).

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

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

parmCorrelationId

Gets or sets the correlation identifier echoed from the request.

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

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

parmErrorCode

Gets or sets the machine-readable failure classification; None on success.

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

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

parmErrors

Gets or sets the failure reasons (the error lines the operation raised); empty on success.

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

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

parmOutcome

Gets or sets the outcome (an MGCLatticeTradeAgreementOutcome value, an integer on the wire).

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

Name	Type	Optional	Description
_outcome	MGCLatticeTradeAgreementOutcome	Yes	The value to set.

parmOutcomeName

Gets or sets the outcome name (the MGCLatticeTradeAgreementOutcome element name).

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

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

parmJournalNum

Gets or sets the price/discount journal number the agreement was posted under.

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

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

parmCreatedAgreementRecId

Gets or sets the RecId of the newly created PriceDiscTable agreement; zero when none was created.

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

Name	Type	Optional	Description
_createdAgreementRecId	int64	Yes	The value to set.

parmSupersededAgreementRecId

Gets or sets the RecId of the agreement that was superseded; zero when none was superseded.

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

Name	Type	Optional	Description
_supersededAgreementRecId	int64	Yes	The value to set.

parmSupersededNewToDate

Gets or sets the new to-date stamped on the superseded agreement (forward-only supersession).

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

Name	Type	Optional	Description
_supersededNewToDate	date	Yes	The value to set.

parmAppliedFromDate

Gets or sets the effective from-date applied to the agreement.

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

Name	Type	Optional	Description
_appliedFromDate	date	Yes	The value to set.

parmAppliedToDate

Gets or sets the effective to-date applied to the agreement.

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

Name	Type	Optional	Description
_appliedToDate	date	Yes	The value to set.

parmAppliedUnitPrice

Gets or sets the unit price actually applied to the agreement.

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

Name	Type	Optional	Description
_appliedUnitPrice	real	Yes	The value to set.