Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM Copyright notice field.

  See Also:

  Constant Field Values

• RESOURCE_NAME

  public static final java.lang.String RESOURCE_NAME
  

  The Constant RESOURCE_NAME.

  See Also:

  Constant Field Values

• RESOURCE_MAPPING_KEY

  public static final java.lang.String RESOURCE_MAPPING_KEY
  

  The Constant RESOURCE_MAPPING_KEY.

  See Also:

  Constant Field Values

• PARAMETER_ONLINE_STORE_ID

  public static final java.lang.String PARAMETER_ONLINE_STORE_ID
  

  online store identifier

  See Also:

  Constant Field Values

• PARAMETER_ONLINE_STORE_ID_DESCRIPTION

  public static final java.lang.String PARAMETER_ONLINE_STORE_ID_DESCRIPTION
  

  online store identifier description

  See Also:

  Constant Field Values

• PARAMETER_PHYSICAL_STORE_IDS

  public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS
  

  physical store identifier

  See Also:

  Constant Field Values

• PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION

  public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION
  

  physical store identifier description

  See Also:

  Constant Field Values

• PARAMETER_PRODUCT_IDS

  public static final java.lang.String PARAMETER_PRODUCT_IDS
  

  product identifier

  See Also:

  Constant Field Values

• PARAMETER_PRODUCT_IDS_DESCRIPTION

  public static final java.lang.String PARAMETER_PRODUCT_IDS_DESCRIPTION
  

  product identifier description

  See Also:

  Constant Field Values

• helper

  protected InventoryHelper helper
  

  Helper to retrieve and deal with BOD.

• RESOURCE_KEY

  public static final java.lang.String RESOURCE_KEY
  

  The Constant RESOURCE_KEY.

  See Also:

  Constant Field Values

• FORMAT_GROUP_NAME

  public static final java.lang.String FORMAT_GROUP_NAME
  

  The constant FORMAT_GROUP_NAME

  See Also:

  Constant Field Values

Constructor Detail

• InventoryHandler

  public InventoryHandler()
  

Method Detail

• getResourceName

  public java.lang.String getResourceName()
  

  Description copied from interface: IResourceHandler
  This method returns the name of the resource used primarily to determine the representation of the resource. This class can be overridden to change the name of the resource and therefore the representation, while keeping all the methods in this class.

  Returns:

  the resource name

• getHelper

  public InventoryHelper getHelper()
  

  Returns the BOD helper associated with the inventory resource. This method can be override to use the extended InventoryHelper for customization.

  Returns:

  InventoryHelper

• getFormattingGroupName

  public java.lang.String getFormattingGroupName()
  

  Description copied from class: AbstractBaseResourceHandler
  Returns the formatting group name for resolving the struts action of the formatting JSP. Overwrite this method in your resource handler class to return a formatting group name specific to your resource handler.

  Specified by:

  getFormattingGroupName in interface IResourceHandler

  Overrides:

  getFormattingGroupName in class AbstractBaseResourceHandler

  Returns:

  the formatting group name.

• getInventoryAvailabilityByProductId

  public javax.ws.rs.core.Response getInventoryAvailabilityByProductId(java.lang.String storeId,
                                                              java.lang.String productIds,
                                                              java.lang.String responseFormat,
                                                              java.lang.String onlineStoreId,
                                                              java.lang.String physicalStoreId)
  

  This method returns the inventory details for the specified product by it's identifier (Catalog Entry Id). Multiple product Ids can be passed to the URI separated by comma ','.

  Parameters:

  storeId - the store identifier, this is mandatory parameter and cann't be null or empty.

  productIds - the product identifier, this is mandatory parameter and cann't be null or empty.

  responseFormat - the response format (xml, json, or atom).

  onlineStoreId - the online store identifier, this is optional parameter and store identifier will be used in case this is null or empty.

  physicalStoreId - the physical store identifier, this is optional parameter and store identifier will be used in case this is null or empty.

  Returns:

  The array of inventory details in the specified format.

• examenValidResponse

  protected boolean examenValidResponse(java.util.Map<java.lang.String,java.lang.Object> inventoryDataMap)
  

  This method examines the ShowInventoryAvailabilityDataAreaType data object to check if it has at least one inventory data.

  Parameters:

  inventoryDataMap -

  Returns:

  boolean whether at least one item of inventory is available

• renderInventoryAvAilability

  public java.util.Map<java.lang.String,java.lang.Object> renderInventoryAvAilability(java.lang.String productId,
                                                                             java.lang.String responseFormat,
                                                                             java.lang.String onlineStoreId,
                                                                             java.lang.String physicalStoreId,
                                                                             BusinessContextType businessContext)
  

  This method builds the response in appropriate format.

  Parameters:

  productId - the product identifier, this is mandatory parameter and cann't be null or empty.

  responseFormat - the response format (xml, json, or atom).

  onlineStoreId - the online store identifier, this is optional parameter and store identifier will be used in case this is null or empty.

  physicalStoreId - the physical store identifier, this is optional parameter and store identifier will be used in case this is null or empty.

  businessContext - the business context for the user.

  Returns:

  The array of inventory details in the specified format.

• postProcess

  public 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. By default, it does nothing. Overwrite this method in your resource handler class to perform any post process, for example, merge maps from multiple DataObjects into a single Map.

  Specified by:

  postProcess in interface IResourceHandler

  Overrides:

  postProcess in class AbstractBaseResourceHandler

  Parameters:

  responseMap - The response Map after each DataObject has been converted to a Map.

• createIntermediary

  public java.util.Map<java.lang.String,java.lang.Object> createIntermediary(commonj.sdo.DataObject dataArea,
                                                                    java.lang.Exception exception,
                                                                    java.lang.String resourceType,
                                                                    java.lang.String urlParamGrpName)
  

  This method populated the map from the OAGIS BOD.

  Parameters:

  dataArea - the data area

  exception - exception

  resourceType - the resource type

  urlParamGrpName - the url param grp name

  Returns:

  the map

• validateInputParameters

  protected void validateInputParameters(java.lang.String... parameters)
                                  throws java.lang.IllegalArgumentException
  

  This method validated the mandatory URI parameters (store and product identifier) and throws InventoryAvailabilityException if they are null, empty or invalid. This method can be extended to change the default behavior.

  Parameters:

  parameters - the array of mandatory parameters from URI.

  Throws:

  java.lang.IllegalArgumentException - IllegalArgumentException

• splitParameter

  protected java.lang.String[] splitParameter(java.lang.String parameter)
  

  This method splits the String by comma.

  Parameters:

  parameter -

  Returns:

  String[]