de.hybris.platform.ordermanagementwebservices.controllers.order

Class OmsOrdersController

java.lang.Object

de.hybris.platform.ordermanagementwebservices.controllers.OmsBaseController

de.hybris.platform.ordermanagementwebservices.controllers.order.OmsOrdersController

public class OmsOrdersController
extends OmsBaseController

WebResource exposing OmsOrderFacade http://host:port/ordermanagementwebservices/orders

Field Summary

Fields inherited from class de.hybris.platform.ordermanagementwebservices.controllers.OmsBaseController

dataMapper, DEFAULT_CURRENT_PAGE, DEFAULT_FIELD_SET, DEFAULT_PAGE_SIZE, DEFAULT_SORT

Constructor Summary

Constructors

Constructor and Description
OmsOrdersController()

Method Summary

Modifier and Type	Method and Description
void	approvePotentiallyFraudulentOrder(java.lang.String code) Request to approve a potentially fraudulent order
OrderCancelRecordEntryWsDTO	createCancelRequest(OrderCancelRequestWsDTO orderCancelRequestWsDTO, java.lang.String code) Request to create order cancellation in the system
protected java.util.Set<OrderStatus>	extractOrderStatuses(java.lang.String statuses)
CancelReasonListWsDTO	getCancelReason() Request to get all CancelReason in the system
OmsOrderFacade	getOmsOrderFacade()
OrderEntrySearchPageWsDTO	getOrderEntriesForOrderCode(java.lang.String code, java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Request to get orderEntries for the given AbstractOrderModel.CODE
OrderEntryWsDTO	getOrderEntryForOrderCodeAndEntryNumber(java.lang.String code, java.lang.String entryNumber, java.lang.String fields) Request to get orderEntry for the given AbstractOrderModel.CODE and AbstractOrderEntryModel.ENTRYNUMBER
OrderWsDTO	getOrderForCode(java.lang.String code, java.lang.String fields) Request to get an order by code
FraudReportListWsDTO	getOrderFraudReports(java.lang.String code, java.lang.String fields) Request to get fraud reports for a certain order
OrderSearchPageWsDto	getOrders(java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Request to get all orders in the system
OrderSearchPageWsDto	getOrdersByStatus(java.lang.String orderStatuses, java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Request to get all orders with certain order status(es)
OrderStatusListWsDTO	getOrderStatuses() Request to get all OrderStatus in the system
void	manuallyReleaseDeliveryCostCommit(java.lang.String code) Request to manually release the OrderModel from the waiting step after delivery cost commit fails.
void	manuallyReleasePaymentReauth(java.lang.String code) Request to manually release the OrderModel from the waiting step after payment reauth fails.
void	manuallyReleasePaymentVoid(java.lang.String code) Request to manually release the OrderModel from the waiting step after payment void fails.
void	manuallyReleaseTaxCommit(java.lang.String code) Request to manually release the OrderModel form the waiting step after tax commit has failed.
void	manuallyReleaseTaxRequote(java.lang.String code) Request to manually release the OrderModel form the waiting step after tax requote fails.
void	manuallyReleaseTaxVoid(java.lang.String code) Request to manually release the OrderModel from the waiting step after tax void fails.
void	rejectPotentiallyFraudulentOrder(java.lang.String code) Request to reject a potentially fraudulent order
OrderWsDTO	submitOrder(OrderRequestWsDTO orderRequestWsDTO, java.lang.String fields) Request to submit order in the system
protected void	validateOrderRequest(OrderRequestWsDTO orderRequestWsDTO) Validates OrderRequestWsDTO for null checks

Methods inherited from class de.hybris.platform.ordermanagementwebservices.controllers.OmsBaseController

createPageable, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OmsOrdersController

public OmsOrdersController()

Method Detail

getOrders

public OrderSearchPageWsDto getOrders(java.lang.String fields,
                                      int currentPage,
                                      int pageSize,
                                      java.lang.String sort)

Request to get all orders in the system

Parameters:

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

the list of orders

getOrderForCode

public OrderWsDTO getOrderForCode(java.lang.String code,
                                  java.lang.String fields)

Request to get an order by code

Parameters:

code - the code of the requested order

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

the order

getOrdersByStatus

public OrderSearchPageWsDto getOrdersByStatus(java.lang.String orderStatuses,
                                              java.lang.String fields,
                                              int currentPage,
                                              int pageSize,
                                              java.lang.String sort)
                                       throws WebserviceValidationException

Request to get all orders with certain order status(es)

Parameters:

orderStatuses - a list of valid order statuses separated by ","

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

the list of orders fulfilling the above conditions

Throws:

WebserviceValidationException - in case of passing a wrong order status validation exception will be thrown

getOrderStatuses

public OrderStatusListWsDTO getOrderStatuses()

Request to get all OrderStatus in the system

Returns:

list of order statuses

getOrderEntriesForOrderCode

public OrderEntrySearchPageWsDTO getOrderEntriesForOrderCode(java.lang.String code,
                                                             java.lang.String fields,
                                                             int currentPage,
                                                             int pageSize,
                                                             java.lang.String sort)

Request to get orderEntries for the given AbstractOrderModel.CODE

Parameters:

code - order's code for the requested order entries

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

the list of orderEntries fulfilling the above conditions

getOrderEntryForOrderCodeAndEntryNumber

public OrderEntryWsDTO getOrderEntryForOrderCodeAndEntryNumber(java.lang.String code,
                                                               java.lang.String entryNumber,
                                                               java.lang.String fields)

Request to get orderEntry for the given AbstractOrderModel.CODE and AbstractOrderEntryModel.ENTRYNUMBER

Parameters:

code - order's code for the requested order entries

entryNumber - the entry number

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

the list of orderEntries fulfilling the above conditions

getCancelReason

public CancelReasonListWsDTO getCancelReason()

Request to get all CancelReason in the system

Returns:

list of cancel reasons

getOrderFraudReports

public FraudReportListWsDTO getOrderFraudReports(java.lang.String code,
                                                 java.lang.String fields)

Request to get fraud reports for a certain order

Parameters:

code - order's code for which to get the fraud reports

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

list of the order's fraud reports

submitOrder

public OrderWsDTO submitOrder(OrderRequestWsDTO orderRequestWsDTO,
                              java.lang.String fields)

Request to submit order in the system

Parameters:

fields - defaulted to DEFAULT but can be FULL or BASIC

orderRequestWsDTO - object representing OrderRequestWsDTO

Returns:

submitted order

validateOrderRequest

protected void validateOrderRequest(OrderRequestWsDTO orderRequestWsDTO)

Validates OrderRequestWsDTO for null checks

Parameters:

orderRequestWsDTO - the OrderRequestWsDTO

approvePotentiallyFraudulentOrder

public void approvePotentiallyFraudulentOrder(java.lang.String code)
                                       throws java.lang.IllegalStateException

Request to approve a potentially fraudulent order

Parameters:

code - order's code for which to approve the fraud check

Throws:

java.lang.IllegalStateException - when the order is not in the OrderStatus.WAIT_FRAUD_MANUAL_CHECK status

rejectPotentiallyFraudulentOrder

public void rejectPotentiallyFraudulentOrder(java.lang.String code)
                                      throws java.lang.IllegalStateException

Request to reject a potentially fraudulent order

Parameters:

code - order's code for which to reject the fraud check

Throws:

java.lang.IllegalStateException - when the order is not in the OrderStatus.WAIT_FRAUD_MANUAL_CHECK status

extractOrderStatuses

protected java.util.Set<OrderStatus> extractOrderStatuses(java.lang.String statuses)

createCancelRequest

public OrderCancelRecordEntryWsDTO createCancelRequest(OrderCancelRequestWsDTO orderCancelRequestWsDTO,
                                                       java.lang.String code)

Request to create order cancellation in the system

Parameters:

orderCancelRequestWsDTO - object representing OrderCancelRequestWsDTO

code - code of the order to be cancelled

Returns:

OrderCancelRecordEntryWsDTO showing the created cancel record

manuallyReleasePaymentVoid

public void manuallyReleasePaymentVoid(java.lang.String code)

Request to manually release the OrderModel from the waiting step after payment void fails.

Parameters:

code - the AbstractOrderModel.CODE for the order to be released

manuallyReleaseTaxVoid

public void manuallyReleaseTaxVoid(java.lang.String code)

Request to manually release the OrderModel from the waiting step after tax void fails.

Parameters:

code - the AbstractOrderModel.CODE for the order to be released

manuallyReleaseTaxCommit

public void manuallyReleaseTaxCommit(java.lang.String code)

Request to manually release the OrderModel form the waiting step after tax commit has failed.

Parameters:

code - the AbstractOrderModel.CODE for the order to be released

manuallyReleaseTaxRequote

public void manuallyReleaseTaxRequote(java.lang.String code)

Request to manually release the OrderModel form the waiting step after tax requote fails.

Parameters:

code - the AbstractOrderModel.CODE for the order to be released

manuallyReleasePaymentReauth

public void manuallyReleasePaymentReauth(java.lang.String code)

Request to manually release the OrderModel from the waiting step after payment reauth fails.

Parameters:

code - the AbstractOrderModel.CODE for the order to be released

manuallyReleaseDeliveryCostCommit

public void manuallyReleaseDeliveryCostCommit(java.lang.String code)

Request to manually release the OrderModel from the waiting step after delivery cost commit fails.

Parameters:

code - the AbstractOrderModel.CODE for the order to be released

getOmsOrderFacade

public OmsOrderFacade getOmsOrderFacade()