com.ibm.commerce.rest.bod.helpers

Class GeoNodeHelper

java.lang.Object

com.ibm.commerce.rest.bod.helpers.GeoNodeHelper

public class GeoNodeHelper
extends java.lang.Object

The Class GeoNodeHelper.

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.

Constructor Summary

Constructors

Constructor and Description
GeoNodeHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor) Instantiates a new geo node helper.

Method Summary

Modifier and Type	Method and Description
ShowGeoNodeDataAreaType	getGeoByParentGeoId(java.lang.String accessProfile, BusinessContextType bContext, java.lang.String parentId) Get geo nodes by parent geo node unique ID.
com.ibm.commerce.rest.utils.Instrumentor	getInstrumentor() Get the instrumentor associated with this request instance.
ShowGeoNodeDataAreaType	getStoreGeoNodeByTypeAndName(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.
ShowGeoNodeDataAreaType	getStoreTopGeoNode(java.lang.String accessProfile, java.lang.String storeId, BusinessContextType bContext) Get top geo nodes.
ShowGeoNodeDataAreaType	getTopGeoNode(java.lang.String accessProfile, BusinessContextType bContext) Deprecated. by getStoreTopGeoNode(String, String, BusinessContextType).

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

Constructor Detail

GeoNodeHelper

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

Instantiates a new geo node 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

getGeoByParentGeoId

public ShowGeoNodeDataAreaType getGeoByParentGeoId(java.lang.String accessProfile,
                                                   BusinessContextType bContext,
                                                   java.lang.String parentId)
                                            throws GeoNodeException

Get geo nodes by parent geo node unique ID.

Parameters:

accessProfile - the access profile

bContext - the business context

parentId - the parent ID

Returns:

the geo node data object

Throws:

GeoNodeException

getTopGeoNode

public ShowGeoNodeDataAreaType getTopGeoNode(java.lang.String accessProfile,
                                             BusinessContextType bContext)
                                      throws GeoNodeException

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

Get top geo nodes.

Parameters:

accessProfile - the access profile

bContext - the business context

Returns:

the geo node data object

Throws:

GeoNodeException

getStoreTopGeoNode

public ShowGeoNodeDataAreaType getStoreTopGeoNode(java.lang.String accessProfile,
                                                  java.lang.String storeId,
                                                  BusinessContextType bContext)
                                           throws GeoNodeException

Get top geo nodes.

Parameters:

accessProfile - the access profile

storeId - the store ID

bContext - the business context

Returns:

the geo node data object

Throws:

GeoNodeException

getStoreGeoNodeByTypeAndName

public ShowGeoNodeDataAreaType getStoreGeoNodeByTypeAndName(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 - the access profile

storeId - the store ID

type - the type of the geo node

name - the name of the type of the geo node

bContext - the business context

Returns:

the geo node data object

Throws:

GeoNodeException