com.ibm.commerce.rest.bod.helpers

Class StoreLocatorHelper

java.lang.Object

com.ibm.commerce.rest.bod.helpers.StoreLocatorHelper

public class StoreLocatorHelper
extends java.lang.Object

This class provides helper methods to get data for GeoNode and PhysicalStore nouns via Store service.

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_ALL_INFORMATION The Constant ACCESS_PROFILE_ALL_INFORMATION.
static java.lang.String	DEFAULT_ACCESS_PROFILE_DETAILS_INFORMATION The Constant ACCESS_PROFILE_DETAILS_INFORMATION.
static java.lang.String	TYPE_CITY The constant TYPE_CITY.
static java.lang.String	TYPE_CNTY The constant TYPE_CNTY.
static java.lang.String	TYPE_PROV The constant TYPE_PROV.
static java.lang.String	TYPE_STAT The constant TYPE_STAT.

Constructor Summary

Constructors

Constructor and Description
StoreLocatorHelper()
StoreLocatorHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor) Instantiates a new store locator helper.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getGeoIdByLocation(java.lang.String accessProfile, java.lang.String locationId, java.lang.String type) Create an intermediary object from the physical store data object.
com.ibm.commerce.rest.utils.Instrumentor	getInstrumentor() Get the instrumentor associated with this request instance.
ShowPhysicalStoreDataAreaType	getPhysicalStore(java.lang.String accessProfile, java.lang.String latitude, java.lang.String longitude, BusinessContextType bContext, java.util.Map conditions, java.util.Map attributes) Deprecated. by getStorePhysicalStore(String, String, String, String, BusinessContextType, Map, Map).
ShowGeoNodeDataAreaType	getPhysicalStorebyGeoNode(java.lang.String accessProfile, java.lang.String type, java.lang.String name, BusinessContextType bContext) Deprecated. by getStorePhysicalStorebyGeoNode(String, String, String, String, BusinessContextType).
ShowPhysicalStoreDataAreaType	getPhysicalStoreDetails(java.lang.String accessProfile, BusinessContextType bContext, java.lang.String geoId, int maxItems, int startNumber, java.lang.String beautyCtr, java.lang.String type) Deprecated. by getStorePhysicalStoreDetails(String, String, BusinessContextType, String, int, int, String, String).
ShowPhysicalStoreDataAreaType	getPhysicalStoreDetailsByStoreId(java.lang.String accessProfile, BusinessContextType bContext, java.lang.String[] uniqueIds, int maxItems, int startNumber) Get physical store by store unique id.
ShowPhysicalStoreDataAreaType	getStorePhysicalStore(java.lang.String accessProfile, java.lang.String storeId, java.lang.String latitude, java.lang.String longitude, BusinessContextType bContext, java.util.Map conditions, java.util.Map attributes) Get physical stores by geo code.
ShowGeoNodeDataAreaType	getStorePhysicalStorebyGeoNode(java.lang.String accessProfile, java.lang.String storeId, java.lang.String type, java.lang.String name, BusinessContextType bContext) Get geo nodes by type and name.
ShowPhysicalStoreDataAreaType	getStorePhysicalStoreDetails(java.lang.String accessProfile, java.lang.String storeId, BusinessContextType bContext, java.lang.String geoId, int maxItems, int startNumber, java.lang.String beautyCtr, java.lang.String type) Get physical stores by geo node unique 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_ALL_INFORMATION

public static final java.lang.String DEFAULT_ACCESS_PROFILE_ALL_INFORMATION

The Constant ACCESS_PROFILE_ALL_INFORMATION.

See Also:

Constant Field Values

DEFAULT_ACCESS_PROFILE_DETAILS_INFORMATION

public static final java.lang.String DEFAULT_ACCESS_PROFILE_DETAILS_INFORMATION

The Constant ACCESS_PROFILE_DETAILS_INFORMATION.

See Also:

Constant Field Values

TYPE_STAT

public static final java.lang.String TYPE_STAT

The constant TYPE_STAT.

See Also:

Constant Field Values

TYPE_CNTY

public static final java.lang.String TYPE_CNTY

The constant TYPE_CNTY.

See Also:

Constant Field Values

TYPE_PROV

public static final java.lang.String TYPE_PROV

The constant TYPE_PROV.

See Also:

Constant Field Values

TYPE_CITY

public static final java.lang.String TYPE_CITY

The constant TYPE_CITY.

See Also:

Constant Field Values

Constructor Detail

StoreLocatorHelper

public StoreLocatorHelper()

StoreLocatorHelper

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

Instantiates a new store locator helper.

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

getPhysicalStore

public ShowPhysicalStoreDataAreaType getPhysicalStore(java.lang.String accessProfile,
                                                      java.lang.String latitude,
                                                      java.lang.String longitude,
                                                      BusinessContextType bContext,
                                                      java.util.Map conditions,
                                                      java.util.Map attributes)
                                               throws PhysicalStoreException

Deprecated. by getStorePhysicalStore(String, String, String, String, BusinessContextType, Map, Map).

Get physical stores by geo code.

Parameters:

accessProfile -

latitude -

longitude -

bContext -

conditions -

attributes -

Returns:

DataObject

Throws:

PhysicalStoreException

getStorePhysicalStore

public ShowPhysicalStoreDataAreaType getStorePhysicalStore(java.lang.String accessProfile,
                                                           java.lang.String storeId,
                                                           java.lang.String latitude,
                                                           java.lang.String longitude,
                                                           BusinessContextType bContext,
                                                           java.util.Map conditions,
                                                           java.util.Map attributes)
                                                    throws PhysicalStoreException

Get physical stores by geo code.

Parameters:

accessProfile -

storeId - The store entity ID.

latitude -

longitude -

bContext -

conditions -

attributes -

Returns:

DataObject

Throws:

PhysicalStoreException

getPhysicalStorebyGeoNode

public ShowGeoNodeDataAreaType getPhysicalStorebyGeoNode(java.lang.String accessProfile,
                                                         java.lang.String type,
                                                         java.lang.String name,
                                                         BusinessContextType bContext)
                                                  throws GeoNodeException

Deprecated. by getStorePhysicalStorebyGeoNode(String, String, String, String, BusinessContextType).

Get geo nodes by type and name.

Parameters:

accessProfile -

type -

name -

bContext -

Returns:

DataObject

Throws:

GeoNodeException

getStorePhysicalStorebyGeoNode

public ShowGeoNodeDataAreaType getStorePhysicalStorebyGeoNode(java.lang.String accessProfile,
                                                              java.lang.String storeId,
                                                              java.lang.String type,
                                                              java.lang.String name,
                                                              BusinessContextType bContext)
                                                       throws GeoNodeException

Get geo nodes by type and name.

Parameters:

accessProfile -

storeId - The store entity ID.

type -

name -

bContext -

Returns:

DataObject

Throws:

GeoNodeException

getGeoIdByLocation

public java.util.List<java.lang.String> getGeoIdByLocation(java.lang.String accessProfile,
                                                           java.lang.String locationId,
                                                           java.lang.String type)
                                                    throws PhysicalStoreException,
                                                           GeoNodeException

Create an intermediary object from the physical store data object.

Parameters:

accessProfile -

locationId -

type -

Returns:

List

Throws:

PhysicalStoreException

GeoNodeException

getPhysicalStoreDetails

public ShowPhysicalStoreDataAreaType getPhysicalStoreDetails(java.lang.String accessProfile,
                                                             BusinessContextType bContext,
                                                             java.lang.String geoId,
                                                             int maxItems,
                                                             int startNumber,
                                                             java.lang.String beautyCtr,
                                                             java.lang.String type)
                                                      throws PhysicalStoreException

Deprecated. by getStorePhysicalStoreDetails(String, String, BusinessContextType, String, int, int, String, String).

Get physical stores by geo node unique ID.

Parameters:

accessProfile -

bContext -

geoId -

maxItems -

startNumber -

beautyCtr -

type -

Returns:

DataObject

Throws:

PhysicalStoreException

getStorePhysicalStoreDetails

public ShowPhysicalStoreDataAreaType getStorePhysicalStoreDetails(java.lang.String accessProfile,
                                                                  java.lang.String storeId,
                                                                  BusinessContextType bContext,
                                                                  java.lang.String geoId,
                                                                  int maxItems,
                                                                  int startNumber,
                                                                  java.lang.String beautyCtr,
                                                                  java.lang.String type)
                                                           throws PhysicalStoreException

Get physical stores by geo node unique ID.

Parameters:

accessProfile -

storeId - The web store entity ID.

bContext -

geoId -

maxItems -

startNumber -

beautyCtr -

type -

Returns:

DataObject

Throws:

PhysicalStoreException

getPhysicalStoreDetailsByStoreId

public ShowPhysicalStoreDataAreaType getPhysicalStoreDetailsByStoreId(java.lang.String accessProfile,
                                                                      BusinessContextType bContext,
                                                                      java.lang.String[] uniqueIds,
                                                                      int maxItems,
                                                                      int startNumber)
                                                               throws PhysicalStoreException

Get physical store by store unique id.

Parameters:

accessProfile -

bContext -

uniqueIds -

maxItems -

startNumber -

Returns:

DataObject

Throws:

PhysicalStoreException