Click or drag to resize

IIdentifierCodeHandlerCheckIdentifierCodeSupport Method (IOrder, IOrderProductItem, String)

Determines whether this handler can process a raw input string representing a product code, and returns detailed support information.

Namespace:  Resto.Front.Api.Data.Orders
Assembly:  Resto.Front.Api.V9 (in Resto.Front.Api.V9.dll)
Syntax
C#
IdentifierCodeSupportResult CheckIdentifierCodeSupport(
	IOrder order,
	IOrderProductItem orderItem,
	string code
)

Parameters

order
Type: Resto.Front.Api.Data.OrdersIOrder
The order associated with the code.
orderItem
Type: Resto.Front.Api.Data.OrdersIOrderProductItem
The product item to which the code is being assigned.
code
Type: SystemString
Raw string input representing the product identifier code.

Return Value

Type: IdentifierCodeSupportResult
An IdentifierCodeSupportResult containing:
  • IsSupported — whether this handler can process the code.
  • CodeHandlerFlags Handler-specific flags describing the properties of the code. Must be set if method returns true
  • Message — optional descriptive message.
Remarks
/// This method is called before the identifier code is added to the order, allowing handlers to indicate whether they support and can process the code. If true is returned and the returned IdentifierCodeHandlerFlags include RequiresVerification, then VerifyIdentifierCode(IOrder, IOrderProductItem, OrderItemIdentifierCode) will be called during the verification step.
See Also