@Encoded public class OrderHandler extends AbstractConfigBasedClassicHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM Copyright notice field.
|
static java.lang.String | FORMAT_GROUP_NAME
The constant FORMAT_GROUP_NAME
|
static java.lang.String | ORDER_DETAIL_MAPPING_KEY
Resource mapping key for order detail
|
static java.lang.String | ORDER_HISTORY_DEFAULT_STATUS
All possible status (with states of N, M, A, B, C, R, S, D, F, G, L, and X) for order history.
|
static java.lang.String | ORDER_HISTORY_STATUS
Deprecated.
Replaced by "N,M,A,B,C,R,S,D,F,G,L,X"
|
static java.lang.String | ORDER_ITEM_CONFIGURATION_MAPPING_KEY
Resource mapping key for order item configuration
|
static java.lang.String | ORDER_SUMMARY_MAPPING_KEY
Resource mapping key for order summary
|
static java.lang.String | PARAMETER_EXTERNAL_ORDER_ID
external order identifier
|
static java.lang.String | PARAMETER_EXTERNAL_ORDER_ID_DESCRIPTION
external order identifier description
|
static java.lang.String | PARAMETER_IS_SUMMARY
summary value
|
static java.lang.String | PARAMETER_IS_SUMMARY_DESCRIPTION
summary value description
|
static java.lang.String | PARAMETER_ORDER_ID
order identifier
|
static java.lang.String | PARAMETER_ORDER_ID_DESCRIPTION
order identifier description
|
static java.lang.String | PARAMETER_ORDER_ITEM_ID
order item identifier
|
static java.lang.String | PARAMETER_ORDER_ITEM_ID_DESCRIPTION
order item identifier description
|
static java.lang.String | PARAMETER_RECORD_SET_TOTAL
total number of records in set
|
static java.lang.String | PARAMETER_RECORD_SET_TOTAL_DESCRIPTION
record set total description
|
static java.lang.String | PARAMETER_RETRIEVAL_ORDER_STATUS
retrieval order status
|
static java.lang.String | PARAMETER_RETRIEVAL_ORDER_STATUS_DESCRIPTION
retrieval order status description
|
static java.lang.String | PARAMETER_START_TIME
start time name
|
static java.lang.String | PARAMETER_START_TIME_DESCRIPTION
start time description
|
static java.lang.String | PARAMETER_STATUS
order status
|
static java.lang.String | PARAMETER_STATUS_DESCRIPTION
order status description
|
static java.lang.String | PARAMETER_USER_ID
user identifier
|
static java.lang.String | PARAMETER_USER_ID_DESCRIPTION
user identifier description
|
static java.lang.String | RESOURCE_NAME
Resource name
|
Constructor and Description |
---|
OrderHandler() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response | findByOrderId(java.lang.String orderId, java.lang.String storeId, java.lang.String responseFormat, int pageNumber, int pageSize)
This method retrieves order detail by an order id.
|
javax.ws.rs.core.Response | findByParentOrderId(java.lang.String storeId)
This method retrieves orders by the parent order identifier.
|
javax.ws.rs.core.Response | findByQuery(java.lang.String storeId, java.lang.String queryName, java.lang.String responseFormat)
Finds orders by a query.
|
javax.ws.rs.core.Response | findByStatus(java.lang.String storeId, java.lang.String status, java.lang.String responseFormat, int pageNumber, int pageSize)
This method retrieves orders by status.
|
javax.ws.rs.core.Response | findByStatusExt(java.lang.String storeId)
This method retrieves order status by the external order ID.
|
javax.ws.rs.core.Response | findChildOrderByOrderItemId(java.lang.String storeId)
This method retrieves child orders by the order item identifier.
|
javax.ws.rs.core.Response | findConfigurationByOrderItemId(java.lang.String storeId)
This method retrieves the order item configuration by an order item ID.
|
javax.ws.rs.core.Response | findOrderHistory(java.lang.String storeId, java.lang.String responseFormat, int pageNumber, int pageSize)
This method retrieves order history for the current shopper.
|
java.lang.String | getFormattingGroupName()
This method returns the format group name to locate JSP template.
|
OrderHelper | getHelper()
This method returns the BOD helper used to get order data
|
protected java.lang.String | getOrderHistoryDefaultStatus()
Returns the comma separated list of order history statuses to be used (i.e.
|
java.lang.String | getResourceName() |
void | initializeQueryRegistry(OperationRegistry registry) |
javax.ws.rs.core.Response | orderProfile(java.lang.String storeId)
This method retrieves the order profile by a user identifier.
|
void | postProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap)
Method to provide post process in out of box JSON/XML entity providers after each DataObject has been converted to a Map and before constructing the REST response.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String RESOURCE_NAME
public static final java.lang.String ORDER_SUMMARY_MAPPING_KEY
public static final java.lang.String ORDER_DETAIL_MAPPING_KEY
public static final java.lang.String ORDER_ITEM_CONFIGURATION_MAPPING_KEY
public static final java.lang.String FORMAT_GROUP_NAME
public static final java.lang.String ORDER_HISTORY_STATUS
public static final java.lang.String PARAMETER_EXTERNAL_ORDER_ID
public static final java.lang.String PARAMETER_EXTERNAL_ORDER_ID_DESCRIPTION
public static final java.lang.String PARAMETER_IS_SUMMARY
public static final java.lang.String PARAMETER_IS_SUMMARY_DESCRIPTION
public static final java.lang.String PARAMETER_ORDER_ID
public static final java.lang.String PARAMETER_ORDER_ID_DESCRIPTION
public static final java.lang.String PARAMETER_ORDER_ITEM_ID
public static final java.lang.String PARAMETER_ORDER_ITEM_ID_DESCRIPTION
public static final java.lang.String PARAMETER_RECORD_SET_TOTAL
public static final java.lang.String PARAMETER_RECORD_SET_TOTAL_DESCRIPTION
public static final java.lang.String PARAMETER_RETRIEVAL_ORDER_STATUS
public static final java.lang.String PARAMETER_RETRIEVAL_ORDER_STATUS_DESCRIPTION
public static final java.lang.String PARAMETER_START_TIME
public static final java.lang.String PARAMETER_START_TIME_DESCRIPTION
public static final java.lang.String PARAMETER_STATUS
public static final java.lang.String PARAMETER_STATUS_DESCRIPTION
public static final java.lang.String PARAMETER_USER_ID
public static final java.lang.String PARAMETER_USER_ID_DESCRIPTION
public static final java.lang.String ORDER_HISTORY_DEFAULT_STATUS
public java.lang.String getResourceName()
public void initializeQueryRegistry(OperationRegistry registry)
public java.lang.String getFormattingGroupName()
public OrderHelper getHelper()
public javax.ws.rs.core.Response findOrderHistory(java.lang.String storeId, java.lang.String responseFormat, int pageNumber, int pageSize)
public javax.ws.rs.core.Response findByOrderId(java.lang.String orderId, java.lang.String storeId, java.lang.String responseFormat, int pageNumber, int pageSize)
public javax.ws.rs.core.Response findByStatus(java.lang.String storeId, java.lang.String status, java.lang.String responseFormat, int pageNumber, int pageSize)
public javax.ws.rs.core.Response findByParentOrderId(java.lang.String storeId)
public javax.ws.rs.core.Response findByQuery(java.lang.String storeId, java.lang.String queryName, java.lang.String responseFormat)
public javax.ws.rs.core.Response findByStatusExt(java.lang.String storeId)
public javax.ws.rs.core.Response findChildOrderByOrderItemId(java.lang.String storeId)
public javax.ws.rs.core.Response findConfigurationByOrderItemId(java.lang.String storeId)
public javax.ws.rs.core.Response orderProfile(java.lang.String storeId) throws RestException
public void postProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap)
protected java.lang.String getOrderHistoryDefaultStatus()