public class InventoryHelper
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright notice field.
|
static java.lang.String |
DEFAULT_ACCESS_PROFILE
The default access profile, used when an access profile is not specified
using the
accessProfile query parameter. |
static java.lang.String |
FIND_BY_STORE_ID_XPATH |
static java.lang.String |
XPATH_EXPRESSION_BY_ID
The expression used when an online store ID and a physical store ID is provided for
inventory details by product Id.
|
static java.lang.String |
XPATH_EXPRESSION_BY_PARTNUMBER
The expression used when an online store ID and a physical store ID is provided for
inventory details by partNumber.
|
static java.lang.String |
XPATH_EXPRESSION_ONLINE_STORE_ONLY_BY_ID
The expression used when only an online store ID is provided for
inventory details by product Id.
|
static java.lang.String |
XPATH_EXPRESSION_ONLINE_STORE_ONLY_BY_PARTNUMBER
The expression used when only an online store ID is provided for
inventory details by partNumber.
|
Constructor and Description |
---|
InventoryHelper() |
InventoryHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)
Overloaded constructor.
|
Modifier and Type | Method and Description |
---|---|
com.ibm.commerce.rest.utils.Instrumentor |
getInstrumentor()
Get the instrumentor associated with this request instance.
|
commonj.sdo.DataObject |
getInventoryAvailabilityByPartNumber(java.lang.String partNumber,
java.lang.String accessProfile,
java.lang.String onlineStoreName,
java.lang.String physicalStoreName,
java.lang.String storeId,
BusinessContextType bContext)
This method retrieves the inventory details for the specified product partNumber.
|
commonj.sdo.DataObject |
getInventoryAvailabilityByPartNumber(java.lang.String partNumber,
java.lang.String accessProfile,
java.lang.String onlineStoreName,
java.lang.String physicalStoreName,
java.lang.String storeId,
BusinessContextType bContext,
javax.security.auth.callback.CallbackHandler callbackHandler)
This method retrieves the inventory details for the specified product partNumber.
|
commonj.sdo.DataObject |
getInventoryavAilabilityByProductId(java.lang.String productId,
java.lang.String accessProfile,
java.lang.String onlineStoreId,
java.lang.String physicalStoreId,
BusinessContextType bContext)
Deprecated.
|
commonj.sdo.DataObject |
getInventoryAvailabilityByProductId(java.lang.String productId,
java.lang.String accessProfile,
java.lang.String onlineStoreId,
java.lang.String physicalStoreId,
BusinessContextType bContext)
This method retrieves the inventory details for the specified product Id.
|
commonj.sdo.DataObject |
getInventoryAvailabilityByProductId(java.lang.String productId,
java.lang.String accessProfile,
java.lang.String onlineStoreId,
java.lang.String physicalStoreId,
BusinessContextType bContext,
javax.security.auth.callback.CallbackHandler callbackHandler)
This method retrieves the inventory details for the specified product Id.
|
java.util.Map |
getInventoryOverallAvailabilityByOrderId(java.lang.String orderId,
java.lang.String accessProfile,
java.lang.String onlineStoreId,
java.lang.String physicalStoreId,
BusinessContextType bContext,
javax.security.auth.callback.CallbackHandler cbh)
This method retrieves the inventory details for the specified product Id.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String DEFAULT_ACCESS_PROFILE
accessProfile
query parameter.public static final java.lang.String XPATH_EXPRESSION_BY_ID
public static final java.lang.String XPATH_EXPRESSION_ONLINE_STORE_ONLY_BY_ID
public static final java.lang.String XPATH_EXPRESSION_ONLINE_STORE_ONLY_BY_PARTNUMBER
public static final java.lang.String XPATH_EXPRESSION_BY_PARTNUMBER
public static final java.lang.String FIND_BY_STORE_ID_XPATH
public InventoryHelper()
public InventoryHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)
instrumentor
- the instrumentorpublic com.ibm.commerce.rest.utils.Instrumentor getInstrumentor()
public commonj.sdo.DataObject getInventoryAvailabilityByProductId(java.lang.String productId, java.lang.String accessProfile, java.lang.String onlineStoreId, java.lang.String physicalStoreId, BusinessContextType bContext) throws InventoryAvailabilityException
productId
- the product identifier.accessProfile
- the access profile for the XPath.onlineStoreId
- the online store identifier.physicalStoreId
- the optional physical store identifier.bContext
- business context.InventoryAvailabilityException
- the inventory availability exceptionpublic commonj.sdo.DataObject getInventoryAvailabilityByProductId(java.lang.String productId, java.lang.String accessProfile, java.lang.String onlineStoreId, java.lang.String physicalStoreId, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler callbackHandler) throws InventoryAvailabilityException
productId
- the product identifier.accessProfile
- the access profile for the XPath.onlineStoreId
- the online store identifier.physicalStoreId
- the optional physical store identifier.bContext
- business context.callbackHandler
- the callback handler.InventoryAvailabilityException
- the inventory availability exceptionpublic commonj.sdo.DataObject getInventoryAvailabilityByPartNumber(java.lang.String partNumber, java.lang.String accessProfile, java.lang.String onlineStoreName, java.lang.String physicalStoreName, java.lang.String storeId, BusinessContextType bContext) throws InventoryAvailabilityException
partNumber
- the product identifier.accessProfile
- the access profile for the XPath.onlineStoreName
- the online store name.physicalStoreName
- the optional physical store External name.bContext
- business context.InventoryAvailabilityException
- the inventory availability exceptionpublic commonj.sdo.DataObject getInventoryAvailabilityByPartNumber(java.lang.String partNumber, java.lang.String accessProfile, java.lang.String onlineStoreName, java.lang.String physicalStoreName, java.lang.String storeId, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler callbackHandler) throws InventoryAvailabilityException
partNumber
- the product identifier.accessProfile
- the access profile for the XPath.onlineStoreName
- the online store name.physicalStoreName
- the optional physical store External name.bContext
- business context.callbackHandler
- the callback handler.InventoryAvailabilityException
- the inventory availability exceptionpublic commonj.sdo.DataObject getInventoryavAilabilityByProductId(java.lang.String productId, java.lang.String accessProfile, java.lang.String onlineStoreId, java.lang.String physicalStoreId, BusinessContextType bContext) throws InventoryAvailabilityException
getInventoryAvailabilityByProductId(String, String, String, String, BusinessContextType)
productId
- the product identifier.accessProfile
- the access profile for the XPath.onlineStoreId
- the online store identifier.physicalStoreId
- the optional physical store identifier.bContext
- business context.InventoryAvailabilityException
- the inventory availability exceptionpublic java.util.Map getInventoryOverallAvailabilityByOrderId(java.lang.String orderId, java.lang.String accessProfile, java.lang.String onlineStoreId, java.lang.String physicalStoreId, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh) throws InventoryAvailabilityException
order
- Id
the order identifier.accessProfile
- the access profile for the XPath.onlineStoreId
- the online store identifier.physicalStoreId
- the optional physical store identifier.bContext
- business context.InventoryAvailabilityException
- the inventory availability exception