com.ibm.commerce.rest.store.handler

Class StoreLocatorHandler

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_DETAILS_INFORMATION

        public static final java.lang.String ACCESS_PROFILE_DETAILS_INFORMATION
        The Constant ACCESS_PROFILE_DETAILS_INFORMATION.
        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_CITY

        public static final java.lang.String PARAMETER_CITY
        city
        See Also:
        Constant Field Values
      • PARAMETER_CITY_DESCRIPTION

        public static final java.lang.String PARAMETER_CITY_DESCRIPTION
        city description
        See Also:
        Constant Field Values
      • PARAMETER_STATE

        public static final java.lang.String PARAMETER_STATE
        state
        See Also:
        Constant Field Values
      • PARAMETER_STATE_DESCRIPTION

        public static final java.lang.String PARAMETER_STATE_DESCRIPTION
        state description
        See Also:
        Constant Field Values
      • PARAMETER_PROV

        public static final java.lang.String PARAMETER_PROV
        province
        See Also:
        Constant Field Values
      • PARAMETER_PROV_DESCRIPTION

        public static final java.lang.String PARAMETER_PROV_DESCRIPTION
        province description
        See Also:
        Constant Field Values
      • PARAMETER_COUNTRY

        public static final java.lang.String PARAMETER_COUNTRY
        country
        See Also:
        Constant Field Values
      • PARAMETER_COUNTRY_DESCRIPTION

        public static final java.lang.String PARAMETER_COUNTRY_DESCRIPTION
        country description
        See Also:
        Constant Field Values
      • PARAMETER_RADIUSUOM

        public static final java.lang.String PARAMETER_RADIUSUOM
        radius UOM
        See Also:
        Constant Field Values
      • PARAMETER_RADIUSUOM_DESCRIPTION

        public static final java.lang.String PARAMETER_RADIUSUOM_DESCRIPTION
        radius UOM description
        See Also:
        Constant Field Values
      • PARAMETER_BEAUTY_CENTER

        public static final java.lang.String PARAMETER_BEAUTY_CENTER
        beauty center
        See Also:
        Constant Field Values
      • PARAMETER_BEAUTY_CENTER_DESCRIPTION

        public static final java.lang.String PARAMETER_BEAUTY_CENTER_DESCRIPTION
        beauty center description
        See Also:
        Constant Field Values
      • PARAMETER_TYPE

        public static final java.lang.String PARAMETER_TYPE
        type
        See Also:
        Constant Field Values
      • PARAMETER_TYPE_DESCRIPTION

        public static final java.lang.String PARAMETER_TYPE_DESCRIPTION
        type description
        See Also:
        Constant Field Values
      • PARAMETER_RADIUS

        public static final java.lang.String PARAMETER_RADIUS
        radius
        See Also:
        Constant Field Values
      • PARAMETER_RADIUS_DESCRIPTION

        public static final java.lang.String PARAMETER_RADIUS_DESCRIPTION
        radius description
        See Also:
        Constant Field Values
      • PARAMETER_SITE_LEVEL_STORE_SEARCH

        public static final java.lang.String PARAMETER_SITE_LEVEL_STORE_SEARCH
        site level store search flag
        See Also:
        Constant Field Values
      • PARAMETER_SITE_LEVEL_STORE_SEARCH_DESCRIPTION

        public static final java.lang.String PARAMETER_SITE_LEVEL_STORE_SEARCH_DESCRIPTION
        site level store search flag description
        See Also:
        Constant Field Values
      • PARAMETER_GEO_ID

        public static final java.lang.String PARAMETER_GEO_ID
        geo ID
        See Also:
        Constant Field Values
      • PARAMETER_GEO_ID_DESCRIPTION

        public static final java.lang.String PARAMETER_GEO_ID_DESCRIPTION
        geo ID description
        See Also:
        Constant Field Values
      • PARAMETER_UNIQUE_ID

        public static final java.lang.String PARAMETER_UNIQUE_ID
        unique ID
        See Also:
        Constant Field Values
      • PARAMETER_UNIQUE_ID_DESCRIPTION

        public static final java.lang.String PARAMETER_UNIQUE_ID_DESCRIPTION
        unique ID description
        See Also:
        Constant Field Values
      • PARAMETER_PHYSICAL_STORE_IDS

        public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS
        physical store ID list
        See Also:
        Constant Field Values
      • PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION

        public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION
        physical store ID list description
        See Also:
        Constant Field Values
      • PARAMETER_LATITUDE

        public static final java.lang.String PARAMETER_LATITUDE
        latitude
        See Also:
        Constant Field Values
      • PARAMETER_LATITUDE_DESCRIPTION

        public static final java.lang.String PARAMETER_LATITUDE_DESCRIPTION
        latitude description
        See Also:
        Constant Field Values
      • PARAMETER_LONGITUDE

        public static final java.lang.String PARAMETER_LONGITUDE
        longitude
        See Also:
        Constant Field Values
      • PARAMETER_LONGITUDE_DESCRIPTION

        public static final java.lang.String PARAMETER_LONGITUDE_DESCRIPTION
        longitude description
        See Also:
        Constant Field Values
      • PARAMETER_MAX_ITEMS

        public static final java.lang.String PARAMETER_MAX_ITEMS
        maximum items
        See Also:
        Constant Field Values
      • PARAMETER_MAX_ITEMS_DESCRIPTION

        public static final java.lang.String PARAMETER_MAX_ITEMS_DESCRIPTION
        maximum item description
        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
      • RESPONSE_STORE_LOCATOR_404_DESCRIPTION

        public static final java.lang.String RESPONSE_STORE_LOCATOR_404_DESCRIPTION
        store locator 404 return code description
        See Also:
        Constant Field Values
    • Constructor Detail

      • StoreLocatorHandler

        public StoreLocatorHandler()
    • 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 StoreLocatorHelper getHelper()
        Return the BOD helper associated with the physical store resource.
        Returns:
        StoreLocatorHelper
      • findGeoNodeByGeoLocation

        @GET
         @Path(value="byLocation")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findGeoNodeByGeoLocation(@PathParam(value="storeId")
                                                                                                                                                                                                          java.lang.String storeId,
                                                                                                                                                                                                          @QueryParam(value="responseFormat")
                                                                                                                                                                                                          java.lang.String responseFormat,
                                                                                                                                                                                                          @QueryParam(value="city")
                                                                                                                                                                                                          java.lang.String city,
                                                                                                                                                                                                          @QueryParam(value="state")
                                                                                                                                                                                                          java.lang.String state,
                                                                                                                                                                                                          @QueryParam(value="prov")
                                                                                                                                                                                                          java.lang.String prov,
                                                                                                                                                                                                          @QueryParam(value="country")
                                                                                                                                                                                                          java.lang.String country,
                                                                                                                                                                                                          @QueryParam(value="radiusUOM")
                                                                                                                                                                                                          java.lang.String radiusUOM,
                                                                                                                                                                                                          @QueryParam(value="BeautyCenter")
                                                                                                                                                                                                          java.lang.String beautyCenter,
                                                                                                                                                                                                          @QueryParam(value="Type")
                                                                                                                                                                                                          java.lang.String typeval,
                                                                                                                                                                                                          @QueryParam(value="radius")
                                                                                                                                                                                                          java.lang.String radius,
                                                                                                                                                                                                          @QueryParam(value="pageNumber")
                                                                                                                                                                                                          int pageNumber,
                                                                                                                                                                                                          @QueryParam(value="pageSize")
                                                                                                                                                                                                          int pageSize,
                                                                                                                                                                                                          @QueryParam(value="siteLevelStoreSearch")
                                                                                                                                                                                                          java.lang.String siteLevelStoreSearch)
        This method return the physical stores information for specified location information.
        Parameters:
        storeId - the store id
        responseFormat - the response format
        city - the city
        state - the state
        prov - the province
        country - the country
        radiusUOM - the radius unit of measure
        beautyCenter - the beauty center
        typeval - the type
        radius - the radius
        pageNumber - the page number
        pageSize - the page size
        siteLevelStoreSearch - If it is "true", a site level physical search will be performed. Otherwise, the physical store search will be performed at the web store level. By default, it is "true".
        Returns:
        Response
      • findGeoNodeByGeoId

        @GET
         @Path(value="byGeoNode/{geoId}")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findGeoNodeByGeoId(@PathParam(value="storeId")
                                                                                                                                                                                                           java.lang.String storeId,
                                                                                                                                                                                                           @PathParam(value="geoId")
                                                                                                                                                                                                           java.lang.String geoId,
                                                                                                                                                                                                           @QueryParam(value="pageNumber")
                                                                                                                                                                                                           int pageNumber,
                                                                                                                                                                                                           @QueryParam(value="pageSize")
                                                                                                                                                                                                           int pageSize,
                                                                                                                                                                                                           @QueryParam(value="BeautyCenter")
                                                                                                                                                                                                           java.lang.String beautyCenter,
                                                                                                                                                                                                           @QueryParam(value="Type")
                                                                                                                                                                                                           java.lang.String type,
                                                                                                                                                                                                           @QueryParam(value="responseFormat")
                                                                                                                                                                                                           java.lang.String responseFormat,
                                                                                                                                                                                                           @QueryParam(value="siteLevelStoreSearch")
                                                                                                                                                                                                           java.lang.String siteLevelStoreSearch)
        This method return the physical stores information for specified geo node unique ID.
        Parameters:
        storeId - the store id
        geoId - the geo id
        pageNumber - the page number
        pageSize - the page size
        beautyCenter - the beauty center
        type - the type
        responseFormat - the response format
        siteLevelStoreSearch - If it is "true", a site level physical search will be performed. Otherwise, the physical store search will be performed at the web store level. By default, it is "true".
        Returns:
        Response
      • findByStoreUniqueId

        @GET
         @Path(value="byStoreId/{uniqueId}")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findByStoreUniqueId(@PathParam(value="storeId")
                                                                                                                                                                                                               java.lang.String storeId,
                                                                                                                                                                                                               @PathParam(value="uniqueId")
                                                                                                                                                                                                               java.lang.String uniqueId,
                                                                                                                                                                                                               @QueryParam(value="responseFormat")
                                                                                                                                                                                                               java.lang.String responseFormat,
                                                                                                                                                                                                               @QueryParam(value="pageNumber")
                                                                                                                                                                                                               int pageNumber,
                                                                                                                                                                                                               @QueryParam(value="pageSize")
                                                                                                                                                                                                               int pageSize)
        This method returns the physical store information by a store unique ID.
        Parameters:
        storeId - the store id
        uniqueId - the physical store unique id
        responseFormat - the response format
        pageNumber - the page number
        pageSize - the page size
        Returns:
        the response
      • findByStoreUniqueIds

        @GET
         @Path(value="byStoreIds")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findByStoreUniqueIds(@PathParam(value="storeId")
                                                                                                                                                                                                      java.lang.String storeId,
                                                                                                                                                                                                      @QueryParam(value="physicalStoreId")
                                                                                                                                                                                                      java.util.List<java.lang.String> physicalStoreId,
                                                                                                                                                                                                      @QueryParam(value="responseFormat")
                                                                                                                                                                                                      java.lang.String responseFormat,
                                                                                                                                                                                                      @QueryParam(value="pageNumber")
                                                                                                                                                                                                      int pageNumber,
                                                                                                                                                                                                      @QueryParam(value="pageSize")
                                                                                                                                                                                                      int pageSize)
        This method returns the physical store information by store unique IDs.
        Parameters:
        storeId - the store id
        physicalStoreId - a list of physical store identifiers
        responseFormat - the response format
        pageNumber - the page number
        pageSize - the page size
        Returns:
        the response
      • findStores

        @GET
         @Path(value="latitude/{latitude}/longitude/{longitude}")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findStores(@PathParam(value="storeId")
                                                                                                                                                                                                                           java.lang.String storeId,
                                                                                                                                                                                                                           @PathParam(value="latitude")
                                                                                                                                                                                                                           java.lang.String latitude,
                                                                                                                                                                                                                           @PathParam(value="longitude")
                                                                                                                                                                                                                           java.lang.String longitude,
                                                                                                                                                                                                                           @QueryParam(value="responseFormat")
                                                                                                                                                                                                                           java.lang.String responseFormat,
                                                                                                                                                                                                                           @QueryParam(value="maxItems")
                                                                                                                                                                                                                           java.lang.String maxNumOfStores,
                                                                                                                                                                                                                           @QueryParam(value="radiusUOM")
                                                                                                                                                                                                                           java.lang.String radiusUOM,
                                                                                                                                                                                                                           @QueryParam(value="BeautyCenter")
                                                                                                                                                                                                                           java.lang.String beautyCenter,
                                                                                                                                                                                                                           @QueryParam(value="Type")
                                                                                                                                                                                                                           java.lang.String type,
                                                                                                                                                                                                                           @QueryParam(value="radius")
                                                                                                                                                                                                                           java.lang.String radius,
                                                                                                                                                                                                                           @QueryParam(value="siteLevelStoreSearch")
                                                                                                                                                                                                                           java.lang.String siteLevelStoreSearch)
        This method return the physical stores information for specified coordinates.
        Parameters:
        storeId - the store id
        latitude - the latitude
        longitude - the longitude
        responseFormat - the response format
        maxNumOfStores - the max number of stores
        radiusUOM - the radius unit of measure
        beautyCenter - the beauty center
        type - the type
        radius - the radius
        siteLevelStoreSearch - If it is "true", a site level physical search will be performed. Otherwise, the physical store search will be performed at the web store level. By default, it is "true".
        Returns:
        Response