public class DefaultOmsOrderFacade extends OmsBaseFacade implements OmsOrderFacade
OmsOrderFacade| Modifier and Type | Field and Description |
|---|---|
protected static java.lang.String |
MANUAL_COMMIT_TAX_EVENT |
protected static java.lang.String |
MANUAL_DELIVERY_COST_COMMIT_EVENT |
protected static java.lang.String |
MANUAL_REAUTH_PAYMENT_EVENT |
protected static java.lang.String |
MANUAL_REQUOTE_TAX_EVENT |
protected static java.lang.String |
MANUAL_VOID_PAYMENT_EVENT |
protected static java.lang.String |
MANUAL_VOID_TAX_EVENT |
protected static java.lang.String |
ORDER_EVENT_NAME |
| Constructor and Description |
|---|
DefaultOmsOrderFacade() |
| Modifier and Type | Method and Description |
|---|---|
void |
approvePotentiallyFraudulentOrder(java.lang.String orderCode)
API to approve a potentially fraudulent order
|
protected OrderCancelRequest |
buildOrderCancelRequest(OrderCancelRequestData orderCancelRequestData,
OrderModel order)
Builds an
OrderCancelRequest. |
protected boolean |
canPerformFraudCheck(OrderModel order)
Verifies if a fraud check can be performed on this order depending on its status.
|
protected java.lang.String |
createGuestCustomerModel(CustomerData customerData)
Create a guest CustomerModel from
CustomerData |
protected java.lang.String |
createGuestIfNotExisting(CustomerData customerData)
Find
CustomerModel based on given PrincipalData.getUid(), otherwise a new guest user will be created
based on CustomerData.If the PrincipalData.getUid() exists, it extracts the existing user using this id,
and ignores the other CustomerData's properties provided in the request. |
OrderCancelRecordEntryData |
createRequestOrderCancel(OrderCancelRequestData orderCancelRequestData)
API to request a order cancel
OrderCancelRequest |
protected void |
executeFraudCheckOperation(OrderModel order,
java.lang.Boolean fraudulent)
Save the order with the new attribute value for fraudulent.
|
protected void |
executeManualReleaseStepOperation(OrderModel order,
java.lang.String event,
OrderStatus orderStatus)
Executes a manual release step for the given event by calling the
BusinessProcessService. |
protected BaseSiteService |
getBaseSiteService() |
protected BaseStoreService |
getBaseStoreService() |
protected BusinessProcessService |
getBusinessProcessService() |
java.util.List<CancelReason> |
getCancelReasons()
API to get all order cancel reasons
|
protected Converter<CustomerData,CustomerModel> |
getCustomerReverseConverter() |
protected EnumerationService |
getEnumerationService() |
protected Converter<FraudReportModel,FraudReportData> |
getFraudReportConverter() |
protected GenericDao<FraudReportModel> |
getFraudReportGenericDao() |
protected ImpersonationService |
getImpersonationService() |
protected OrderByNullVersionIdPagedDao |
getOrderByNullVersionIdPagedDao() |
protected Converter<OrderCancelRecordEntryModel,OrderCancelRecordEntryData> |
getOrderCancelRecordEntryConverter() |
protected OrderCancelService |
getOrderCancelService() |
protected Converter<OrderModel,OrderData> |
getOrderConverter() |
SearchPageData<OrderEntryData> |
getOrderEntriesForOrderCode(java.lang.String orderCode,
PageableData pageableData)
API to get orderEntries for the given
AbstractOrderModel.CODE |
protected Converter<OrderEntryModel,OrderEntryData> |
getOrderEntryConverter() |
OrderEntryData |
getOrderEntryForOrderCodeAndEntryNumber(java.lang.String orderCode,
java.lang.Integer entryNumber)
API to get an orderEntry by it's entryNumber and its order's code
|
protected PagedGenericDao<OrderEntryModel> |
getOrderEntryPagedGenericDao() |
OrderData |
getOrderForCode(java.lang.String orderCode)
API to get an order by it's code
|
java.util.List<FraudReportData> |
getOrderFraudReports(java.lang.String orderCode)
API to get an order's fraud reports
|
protected Converter<OrderRequestData,OrderModel> |
getOrderRequestReverseConverter() |
SearchPageData<OrderData> |
getOrders(PageableData pageableData)
API to get all orders in the system
|
SearchPageData<OrderData> |
getOrdersByStatuses(PageableData pageableData,
java.util.Set<OrderStatus> orderStatusSet)
API to get all orders in the system that have certain status(es)
|
protected SearchByStatusPagedGenericDao<OrderModel> |
getOrderSearchByStatusPagedDao() |
protected OrderService |
getOrderService() |
java.util.List<OrderStatus> |
getOrderStatuses()
API to get all order statuses
|
protected UserService |
getUserService() |
protected java.lang.Boolean |
isCancelQuantityPossible(OrderCancelRequestData orderCancelRequestData,
OrderModel order,
UserModel user)
check the given quantity is valid to cancel
|
protected java.lang.Boolean |
isPartialCancel(OrderCancelRequestData orderCancelRequestData,
OrderModel order)
check if is a partial cancel
|
protected java.lang.Boolean |
isPartialEntryCancel(OrderCancelRequestData orderCancelRequestData,
OrderModel order)
check if is a partial order entry cancel
|
void |
manuallyReleaseDeliveryCostCommit(java.lang.String orderCode)
API to manually commit delivery cost taxes and release
OrderModel from waiting step. |
void |
manuallyReleasePaymentReauth(java.lang.String orderCode)
API to manually reauth payment and release
OrderModel from waiting step. |
void |
manuallyReleasePaymentVoid(java.lang.String orderCode)
API to manually release void payment in waiting step.
|
void |
manuallyReleaseTaxCommit(java.lang.String orderCode)
API to manually commit tax and release
OrderModel from waiting step. |
void |
manuallyReleaseTaxRequote(java.lang.String orderCode)
API to manually requote tax and release
OrderModel from waiting step. |
void |
manuallyReleaseTaxVoid(java.lang.String orderCode)
API to manually release void tax in waiting step.
|
void |
rejectPotentiallyFraudulentOrder(java.lang.String orderCode)
API to reject a potentially fraudulent order
|
void |
setBaseSiteService(BaseSiteService baseSiteService) |
void |
setBaseStoreService(BaseStoreService baseStoreService) |
void |
setBusinessProcessService(BusinessProcessService businessProcessService) |
void |
setCustomerReverseConverter(Converter<CustomerData,CustomerModel> customerReverseConverter) |
void |
setEnumerationService(EnumerationService enumerationService) |
void |
setFraudReportConverter(Converter<FraudReportModel,FraudReportData> fraudReportConverter) |
void |
setFraudReportGenericDao(GenericDao<FraudReportModel> fraudReportGenericDao) |
void |
setImpersonationService(ImpersonationService impersonationService) |
void |
setOrderByNullVersionIdPagedDao(OrderByNullVersionIdPagedDao orderByNullVersionIdPagedDao) |
void |
setOrderCancelRecordEntryConverter(Converter<OrderCancelRecordEntryModel,OrderCancelRecordEntryData> orderCancelRecordEntryConverter) |
void |
setOrderCancelService(OrderCancelService orderCancelService) |
void |
setOrderConverter(Converter<OrderModel,OrderData> orderConverter) |
void |
setOrderEntryConverter(Converter<OrderEntryModel,OrderEntryData> orderEntryConverter) |
void |
setOrderEntryPagedGenericDao(PagedGenericDao<OrderEntryModel> orderEntryPagedGenericDao) |
void |
setOrderRequestReverseConverter(Converter<OrderRequestData,OrderModel> orderRequestReverseConverter) |
void |
setOrderSearchByStatusPagedDao(SearchByStatusPagedGenericDao<OrderModel> orderSearchByStatusPagedDao) |
void |
setOrderService(OrderService orderService) |
void |
setUserService(UserService userService) |
OrderData |
submitOrder(OrderRequestData orderRequestData)
API to submit an
OrderModel in the system |
protected OrderData |
submitOrderInContext(OrderModel orderModel)
prepare impersonation context and submit order
|
OrderData |
submitValidatedOrder(OrderRequestData orderRequestData)
submit order after the validation applied
|
protected void |
validateAddressData(AddressData addressData)
Validates for null check and essential fields in
AddressData |
protected void |
validateBaseStoreInSite(java.lang.String storeUid,
java.lang.String siteUid) |
protected void |
validateCancelEntryData(OrderCancelEntryData entry)
Validates for null check and mandatory fields in OrderCancelEntryData
|
protected void |
validateOrderData(OrderRequestData orderRequestData)
Validates for null check and essential fields in
OrderRequestData |
protected void |
validateOrderEntryRequestData(java.util.List<OrderEntryRequestData> orderEntryRequestData)
Validates for null check and essential fields in
OrderEntryRequestData |
protected void |
validatePaymentTransactions(java.util.List<PaymentTransactionData> paymentTransactionDatas)
Validates for null check and essential fields in
PaymentTransactionData
If PaymentTransactions not provide correctly, manual refund payment action may require during the return process |
protected void |
validateReturnRequestData(OrderCancelRequestData orderCancelRequestData)
Validates for null check and mandatory fields in OrderCancelRequestData
|
protected void |
validateUserData(CustomerData customerData)
Validates for essential fields to assign
UserModel to the submitted OrderModel |
convertSearchPageData, createPaginationData, discardOrderSnapshot, getModelService, getOrderGenericDao, getOrderModelForCode, setModelService, setOrderGenericDaoprotected static final java.lang.String ORDER_EVENT_NAME
protected static final java.lang.String MANUAL_VOID_PAYMENT_EVENT
protected static final java.lang.String MANUAL_VOID_TAX_EVENT
protected static final java.lang.String MANUAL_COMMIT_TAX_EVENT
protected static final java.lang.String MANUAL_REQUOTE_TAX_EVENT
protected static final java.lang.String MANUAL_REAUTH_PAYMENT_EVENT
protected static final java.lang.String MANUAL_DELIVERY_COST_COMMIT_EVENT
public SearchPageData<OrderData> getOrders(PageableData pageableData)
OmsOrderFacadegetOrders in interface OmsOrderFacadepageableData - pageable object that contains info on the number or pages and how many items in each page in addition
the sorting infopublic OrderData getOrderForCode(java.lang.String orderCode)
OmsOrderFacadegetOrderForCode in interface OmsOrderFacadeorderCode - the order's codepublic SearchPageData<OrderData> getOrdersByStatuses(PageableData pageableData, java.util.Set<OrderStatus> orderStatusSet)
OmsOrderFacadegetOrdersByStatuses in interface OmsOrderFacadepageableData - pageable object that contains info on the number or pages and how many items in each page in addition
the sorting infoorderStatusSet - set of order status(s) in which we want to get list of orders forpublic java.util.List<OrderStatus> getOrderStatuses()
OmsOrderFacadegetOrderStatuses in interface OmsOrderFacadeOrderStatuspublic SearchPageData<OrderEntryData> getOrderEntriesForOrderCode(java.lang.String orderCode, PageableData pageableData)
OmsOrderFacadeAbstractOrderModel.CODEgetOrderEntriesForOrderCode in interface OmsOrderFacadeorderCode - the order's codepageableData - pageable object that contains info on the number or pages and how many items in each page in addition
the sorting infopublic OrderEntryData getOrderEntryForOrderCodeAndEntryNumber(java.lang.String orderCode, java.lang.Integer entryNumber)
OmsOrderFacadegetOrderEntryForOrderCodeAndEntryNumber in interface OmsOrderFacadeorderCode - the order's codeentryNumber - the order entry's numberpublic java.util.List<FraudReportData> getOrderFraudReports(java.lang.String orderCode)
OmsOrderFacadegetOrderFraudReports in interface OmsOrderFacadeorderCode - code of the order for which to get the fraud reportspublic void approvePotentiallyFraudulentOrder(java.lang.String orderCode)
throws java.lang.IllegalStateException
OmsOrderFacadeapprovePotentiallyFraudulentOrder in interface OmsOrderFacadeorderCode - code of the order for which to approve the fraud checkjava.lang.IllegalStateExceptionpublic void rejectPotentiallyFraudulentOrder(java.lang.String orderCode)
throws java.lang.IllegalStateException
OmsOrderFacaderejectPotentiallyFraudulentOrder in interface OmsOrderFacadeorderCode - code of the order for which to reject the fraud checkjava.lang.IllegalStateExceptionpublic java.util.List<CancelReason> getCancelReasons()
OmsOrderFacadegetCancelReasons in interface OmsOrderFacadeCancelReasonpublic OrderCancelRecordEntryData createRequestOrderCancel(OrderCancelRequestData orderCancelRequestData)
OmsOrderFacadeOrderCancelRequestcreateRequestOrderCancel in interface OmsOrderFacadeorderCancelRequestData - the OrderCancelRequestData to create OrderCancelRequestDataOrderCancelRecordEntryData representing the cancel request that was createdpublic OrderData submitOrder(OrderRequestData orderRequestData)
OmsOrderFacadeOrderModel in the systemsubmitOrder in interface OmsOrderFacadeorderRequestData - the OrderRequestData to submit an OrderModelOrderDatapublic void manuallyReleasePaymentVoid(java.lang.String orderCode)
OmsOrderFacademanuallyReleasePaymentVoid in interface OmsOrderFacadeorderCode - the AbstractOrderModel.CODEpublic void manuallyReleaseTaxVoid(java.lang.String orderCode)
OmsOrderFacademanuallyReleaseTaxVoid in interface OmsOrderFacadeorderCode - the AbstractOrderModel.CODEpublic void manuallyReleaseTaxCommit(java.lang.String orderCode)
OmsOrderFacadeOrderModel from waiting step.manuallyReleaseTaxCommit in interface OmsOrderFacadeorderCode - the AbstractOrderModel.CODEpublic void manuallyReleaseTaxRequote(java.lang.String orderCode)
OmsOrderFacadeOrderModel from waiting step.manuallyReleaseTaxRequote in interface OmsOrderFacadeorderCode - the AbstractOrderModel.CODEpublic void manuallyReleasePaymentReauth(java.lang.String orderCode)
OmsOrderFacadeOrderModel from waiting step.manuallyReleasePaymentReauth in interface OmsOrderFacadeorderCode - the AbstractOrderModel.CODEpublic void manuallyReleaseDeliveryCostCommit(java.lang.String orderCode)
OmsOrderFacadeOrderModel from waiting step.manuallyReleaseDeliveryCostCommit in interface OmsOrderFacadeorderCode - the AbstractOrderModel.CODEprotected void executeManualReleaseStepOperation(OrderModel order, java.lang.String event, OrderStatus orderStatus)
BusinessProcessService.order - the OrderModel to be releasedevent - the business process event to be triggeredprotected OrderCancelRequest buildOrderCancelRequest(OrderCancelRequestData orderCancelRequestData, OrderModel order)
OrderCancelRequest.orderCancelRequestData - the OrderCancelRequestData out of which the request will be builtorder - the OrderModel associated with this requestOrderCancelRequestpublic OrderData submitValidatedOrder(OrderRequestData orderRequestData)
orderRequestData - OrderRequestDataOrderDataprotected OrderData submitOrderInContext(OrderModel orderModel)
orderModel - OrderModelOrderDataprotected void validateOrderData(OrderRequestData orderRequestData)
OrderRequestDataorderRequestData - OrderRequestData to be validatedprotected void validateUserData(CustomerData customerData)
UserModel to the submitted OrderModelcustomerData - the CustomerDataprotected void validateBaseStoreInSite(java.lang.String storeUid,
java.lang.String siteUid)
protected void validatePaymentTransactions(java.util.List<PaymentTransactionData> paymentTransactionDatas)
PaymentTransactionData
If PaymentTransactions not provide correctly, manual refund payment action may require during the return processpaymentTransactionDatas - the PaymentTransactionData(s) to be validatedprotected void validateAddressData(AddressData addressData)
AddressDataaddressData - address to be validatedprotected void validateOrderEntryRequestData(java.util.List<OrderEntryRequestData> orderEntryRequestData)
OrderEntryRequestDataorderEntryRequestData - OrderEntryRequestData to be validatedprotected void executeFraudCheckOperation(OrderModel order, java.lang.Boolean fraudulent)
order - an OrderModelfraudulent - whether the order is actually fraudulentprotected boolean canPerformFraudCheck(OrderModel order)
order - the order whose status will be checkedprotected void validateReturnRequestData(OrderCancelRequestData orderCancelRequestData)
orderCancelRequestData - orderCancelRequest to be validatedprotected void validateCancelEntryData(OrderCancelEntryData entry)
entry - protected java.lang.Boolean isPartialCancel(OrderCancelRequestData orderCancelRequestData, OrderModel order)
orderCancelRequestData - order - protected java.lang.Boolean isPartialEntryCancel(OrderCancelRequestData orderCancelRequestData, OrderModel order)
orderCancelRequestData - order - protected java.lang.Boolean isCancelQuantityPossible(OrderCancelRequestData orderCancelRequestData, OrderModel order, UserModel user)
orderCancelRequestData - order - user - protected java.lang.String createGuestCustomerModel(CustomerData customerData)
CustomerDatacustomerData - the CustomerDataprotected java.lang.String createGuestIfNotExisting(CustomerData customerData)
CustomerModel based on given PrincipalData.getUid(), otherwise a new guest user will be created
based on CustomerData.If the PrincipalData.getUid() exists, it extracts the existing user using this id,
and ignores the other CustomerData's properties provided in the request.customerData - the CustomerDataprotected EnumerationService getEnumerationService()
public void setEnumerationService(EnumerationService enumerationService)
protected Converter<OrderModel,OrderData> getOrderConverter()
public void setOrderConverter(Converter<OrderModel,OrderData> orderConverter)
protected Converter<OrderEntryModel,OrderEntryData> getOrderEntryConverter()
public void setOrderEntryConverter(Converter<OrderEntryModel,OrderEntryData> orderEntryConverter)
protected OrderService getOrderService()
public void setOrderService(OrderService orderService)
protected BusinessProcessService getBusinessProcessService()
public void setBusinessProcessService(BusinessProcessService businessProcessService)
protected Converter<FraudReportModel,FraudReportData> getFraudReportConverter()
public void setFraudReportConverter(Converter<FraudReportModel,FraudReportData> fraudReportConverter)
protected GenericDao<FraudReportModel> getFraudReportGenericDao()
public void setFraudReportGenericDao(GenericDao<FraudReportModel> fraudReportGenericDao)
protected ImpersonationService getImpersonationService()
public void setImpersonationService(ImpersonationService impersonationService)
protected Converter<OrderRequestData,OrderModel> getOrderRequestReverseConverter()
public void setOrderRequestReverseConverter(Converter<OrderRequestData,OrderModel> orderRequestReverseConverter)
protected OrderCancelService getOrderCancelService()
public void setOrderCancelService(OrderCancelService orderCancelService)
protected UserService getUserService()
public void setUserService(UserService userService)
protected BaseSiteService getBaseSiteService()
public void setBaseSiteService(BaseSiteService baseSiteService)
protected BaseStoreService getBaseStoreService()
public void setBaseStoreService(BaseStoreService baseStoreService)
protected Converter<CustomerData,CustomerModel> getCustomerReverseConverter()
public void setCustomerReverseConverter(Converter<CustomerData,CustomerModel> customerReverseConverter)
protected SearchByStatusPagedGenericDao<OrderModel> getOrderSearchByStatusPagedDao()
public void setOrderSearchByStatusPagedDao(SearchByStatusPagedGenericDao<OrderModel> orderSearchByStatusPagedDao)
protected OrderByNullVersionIdPagedDao getOrderByNullVersionIdPagedDao()
public void setOrderByNullVersionIdPagedDao(OrderByNullVersionIdPagedDao orderByNullVersionIdPagedDao)
protected PagedGenericDao<OrderEntryModel> getOrderEntryPagedGenericDao()
public void setOrderEntryPagedGenericDao(PagedGenericDao<OrderEntryModel> orderEntryPagedGenericDao)
protected Converter<OrderCancelRecordEntryModel,OrderCancelRecordEntryData> getOrderCancelRecordEntryConverter()
public void setOrderCancelRecordEntryConverter(Converter<OrderCancelRecordEntryModel,OrderCancelRecordEntryData> orderCancelRecordEntryConverter)
Copyright © 2018 SAP SE. All Rights Reserved.