RequiredHandlingCy, RequiredHandling
Use this component to verify that the handling total is present in the order.
The RequiredHandling component is for backward compatibility only. The RequiredHandlingCy component operates in both Site Server 3.0 Commerce Edition compatibility mode and in Commerce Server 2000 mode pipelines. For more information, see Currency Enhancements.
Intended use: Order Processing pipeline, Handling stage.
Configuration Values
None.
Values Read
The RequiredHandlingCy component reads the following values from the indicated dictionaries. The RequiredHandling component reads the same key but without cy_.
| Key | Dictionary | Description |
_cy_handling_total |
Order | The total cost for handling the order. |
MessageManager |
Context | A reference to a MessageManager object. This key is used to retrieve the bad-handling total constant (pur_badhandling) in case of an error. |
Values Written
The RequiredHandlingCy and RequiredHandling components write the following value to the Order dictionary.
| Key | Description |
_Purchase_Errors |
Error messages are written to this SimpleList object. |
Errors
The RequiredHandlingCy and RequiredHandling components return error level 2 (OPPERRORLEV_WARN) when the handling total is not in the order form. Other errors return error level 3 (OPPERRORLEV_FAIL).
The components write error messages to the _Purchase_Errors collection. The components use a MessageManager object to retrieve user warning message text.
| Constant | Condition |
pur_badhandling |
The handling total is not in the order form. |
Remarks
The RequiredHandlingCy and RequiredHandling components verify that the order._handling_total key is present.