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 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
      • 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