com.ibm.commerce.rest.bod.helpers

Class InventoryHelper

java.lang.Object

com.ibm.commerce.rest.bod.helpers.InventoryHelper

public class InventoryHelper
extends java.lang.Object

The Class InventoryHelper.

Field Summary

Fields

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 Summary

Constructors

Constructor and Description
InventoryHelper()
InventoryHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor) Overloaded constructor.

Method Summary

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. Replaced by getInventoryAvailabilityByProductId(String, String, String, String, BusinessContextType)
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.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

DEFAULT_ACCESS_PROFILE

public static final java.lang.String DEFAULT_ACCESS_PROFILE

The default access profile, used when an access profile is not specified using the accessProfile query parameter.

See Also:

Constant Field Values

XPATH_EXPRESSION_BY_ID

public static final 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.

See Also:

Constant Field Values

XPATH_EXPRESSION_ONLINE_STORE_ONLY_BY_ID

public static final 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.

See Also:

Constant Field Values

XPATH_EXPRESSION_ONLINE_STORE_ONLY_BY_PARTNUMBER

public static final 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.

See Also:

Constant Field Values

XPATH_EXPRESSION_BY_PARTNUMBER

public static final 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.

See Also:

Constant Field Values

FIND_BY_STORE_ID_XPATH

public static final java.lang.String FIND_BY_STORE_ID_XPATH

See Also:

Constant Field Values

Constructor Detail

InventoryHelper

public InventoryHelper()

InventoryHelper

public InventoryHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)

Overloaded constructor.

Parameters:

instrumentor - the instrumentor

Method Detail

getInstrumentor

public com.ibm.commerce.rest.utils.Instrumentor getInstrumentor()

Get the instrumentor associated with this request instance.

Returns:

the instrumentor

getInventoryAvailabilityByProductId

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

This method retrieves the inventory details for the specified product Id.

Parameters:

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.

Returns:

the data object for the inventory availability.

Throws:

InventoryAvailabilityException - the inventory availability exception

getInventoryAvailabilityByProductId

public 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

This method retrieves the inventory details for the specified product Id.

Parameters:

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.

Returns:

the data object for the inventory availability.

Throws:

InventoryAvailabilityException - the inventory availability exception

getInventoryAvailabilityByPartNumber

public 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

This method retrieves the inventory details for the specified product partNumber.

Parameters:

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.

Returns:

the data object for the inventory availability.

Throws:

InventoryAvailabilityException - the inventory availability exception

getInventoryAvailabilityByPartNumber

public 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

This method retrieves the inventory details for the specified product partNumber.

Parameters:

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.

Returns:

the data object for the inventory availability.

Throws:

InventoryAvailabilityException - the inventory availability exception

getInventoryavAilabilityByProductId

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

Deprecated. Replaced by getInventoryAvailabilityByProductId(String, String, String, String, BusinessContextType)

This method retrieves the inventory details for the specified product Id.

Parameters:

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.

Returns:

the data object for the inventory availability.

Throws:

InventoryAvailabilityException - the inventory availability exception

getInventoryOverallAvailabilityByOrderId

public 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

This method retrieves the inventory details for the specified product Id.

Parameters:

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.

Returns:

the data object for the inventory availability.

Throws:

InventoryAvailabilityException - the inventory availability exception