com.secutix.plugin.paymentintegration.service

Interface ExternalOrderService

All Known Implementing Classes:

ExternalOrderServiceEmpty

public interface ExternalOrderService

This interface appointed for calling a facade for public Web Service ExternalOrderService For more detail information about Web Service, please refer to the link of API documentation below

See Also:

ExternalOrderService_v1_23

Method Summary

Modifier and Type	Method and Description
default WebMethodResult	abandonOrder(Long orderId, OrderAbandonedReason reason) To abandon an order in state OPEN.
CloseOrderResult	closeOrder(Integer requestId, ContactData purchaserInfo, Long orderId, List<TicketData> tickets, String externalReference, boolean generateBarCodes, Long maxWaitingTime, OrderType orderType, String externalRemark) To close an opened or validated order.
FileDetailResult	getFileDetails(Integer requestId, Long fileId, Long operationId, Long movementId, Boolean currentView, FileDetailGranularity granularity, OrderDetailGranularity orderDetailGranularity) Get the file details.
OrderDetailResult	getOrderDetails(Long orderId, Long operationId, Long movementId, String orderToken, OrderDetailGranularity granularity) Returns the content of an order.
default Optional<Long>	getPointOfSalesIdFromCodes(String salesChannelCode, String pointOfSalesCode) Utility method allowing to extract of point of sales id from reference codes.
CloseOrderResult	notifyOrder(long orderId, long maxWaitingTime) This method finalizes the order and should be called every time after closeOrder(Integer, ContactData, Long, List, String, boolean, Long, OrderType, String)

Method Detail

getOrderDetails

OrderDetailResult getOrderDetails(Long orderId,
                                  Long operationId,
                                  Long movementId,
                                  String orderToken,
                                  OrderDetailGranularity granularity)

Returns the content of an order. Can be used to check the status an order at any moment of the process. Mostly it uses for checking order status after different order manipulation: creation, updating, closing.

Parameters:

orderId - Order Id as Long

operationId - Operation Id as Long

movementId - Movement Id as Long

orderToken - Order token as String

granularity - OrderDetailGranularity

Returns:

OrderDetailResult

getFileDetails

FileDetailResult getFileDetails(Integer requestId,
                                Long fileId,
                                Long operationId,
                                Long movementId,
                                Boolean currentView,
                                FileDetailGranularity granularity,
                                OrderDetailGranularity orderDetailGranularity)

Get the file details. Expects that exactly one of the three parameters is non-null and valid.

Parameters:

requestId - Request Id as Long

fileId - File Id as Long

operationId - Operation Id as Long

movementId - Movement Id as Long

currentView - Boolean value

granularity - FileDetailGranularity

orderDetailGranularity - OrderDetailGranularity

Returns:

FileDetailResult

closeOrder

CloseOrderResult closeOrder(Integer requestId,
                            ContactData purchaserInfo,
                            Long orderId,
                            List<TicketData> tickets,
                            String externalReference,
                            boolean generateBarCodes,
                            Long maxWaitingTime,
                            OrderType orderType,
                            String externalRemark)

To close an opened or validated order. closeOrder may take some time. If after "maxWaitingTime" milliseconds, order is not closed, the function will return an "in_progress" status.

Parameters:

requestId - Order Id as Long

purchaserInfo - ContactData

orderId - Order Id as Long

tickets - List of TicketData

externalReference - External reference as String

generateBarCodes - Boolean value

maxWaitingTime - Maximal of time waiting as Long

orderType - OrderType

externalRemark - External remark as String

Returns:

CloseOrderResult

notifyOrder

CloseOrderResult notifyOrder(long orderId,
                             long maxWaitingTime)

This method finalizes the order and should be called every time after closeOrder(Integer, ContactData, Long, List, String, boolean, Long, OrderType, String)

Parameters:

orderId - Order Id as Long

maxWaitingTime - Maximal of time waiting as Long

Returns:

CloseOrderResult

getPointOfSalesIdFromCodes

default Optional<Long> getPointOfSalesIdFromCodes(String salesChannelCode,
                                                  String pointOfSalesCode)

Utility method allowing to extract of point of sales id from reference codes.

Parameters:

salesChannelCode -

pointOfSalesCode -

Returns:

abandonOrder

default WebMethodResult abandonOrder(Long orderId,
                                     OrderAbandonedReason reason)

To abandon an order in state OPEN.

Parameters:

orderId -

reason -

Returns: