com.ibm.commerce.rest.store.handler

Class GeoNodeHandler

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

        public static final java.lang.String GEO_TOP_RESOURCE_MAPPING_KEY
        The Constant GEO_TOP_RESOURCE_MAPPING_KEY.
        See Also:
        Constant Field Values
      • PARAMETER_SITE_LEVEL_SEARCH

        public static final java.lang.String PARAMETER_SITE_LEVEL_SEARCH
        site level search flag
        See Also:
        Constant Field Values
      • PARAMETER_SITE_LEVEL_SEARCH_DESCRIPTION

        public static final java.lang.String PARAMETER_SITE_LEVEL_SEARCH_DESCRIPTION
        site level search flag description
        See Also:
        Constant Field Values
      • PARAMETER_PARENT_GEO_ID

        public static final java.lang.String PARAMETER_PARENT_GEO_ID
        parent Geo Node identifier
        See Also:
        Constant Field Values
      • PARAMETER_PARENT_GEO_ID_DESCRIPTION

        public static final java.lang.String PARAMETER_PARENT_GEO_ID_DESCRIPTION
        parent Geo Node identifier 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
    • Constructor Detail

      • GeoNodeHandler

        public GeoNodeHandler()
    • 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 GeoNodeHelper getHelper()
        Return the BOD helper associated with the geo node resource.
        Returns:
        GeoNodeHelper
      • findTopGeoNodes

        @GET
         @Path(value="byTopGeoNode")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findTopGeoNodes(@PathParam(value="storeId")
                                                                                                                                                                                                   java.lang.String storeId,
                                                                                                                                                                                                   @QueryParam(value="responseFormat")
                                                                                                                                                                                                   java.lang.String responseFormat,
                                                                                                                                                                                                   @QueryParam(value="siteLevelSearch")
                                                                                                                                                                                                   java.lang.String siteLevelSearch)
        This method retrieves top geo nodes details.
        Parameters:
        storeId - the store id
        responseFormat - the response format
        siteLevelSearch - The site level search flag. If it is presented and is set to 'true', a site level search will be performed; otherwise, a store level search will be performed. Optional parameter; when it is not set, it is defaulted to 'true'.
        Returns:
        Response
      • findTopGeoNodes

        @GET
         @Path(value="byTopGeoNode")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findTopGeoNodes(@PathParam(value="storeId")
                                                                                                                                                                                                   java.lang.String storeId,
                                                                                                                                                                                                   @QueryParam(value="responseFormat")
                                                                                                                                                                                                   java.lang.String responseFormat)
        Deprecated. Adding query parameter "siteLevelSearch"
        This method retrieves top geo nodes details for the site.
        Parameters:
        storeId - the store id
        responseFormat - the response format
        Returns:
        Response
      • findGeoByParentGeoId

        @GET
         @Path(value="byParentGeoNode/{parentgeoid}")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findGeoByParentGeoId(@PathParam(value="storeId")
                                                                                                                                                                                                                         java.lang.String storeId,
                                                                                                                                                                                                                         @PathParam(value="parentgeoid")
                                                                                                                                                                                                                         java.lang.String parentgeoid,
                                                                                                                                                                                                                         @QueryParam(value="responseFormat")
                                                                                                                                                                                                                         java.lang.String responseFormat)
        This method retrieves geo nodes by parent geo node unique ID.
        Parameters:
        storeId - the store id
        parentgeoid - the parentgeoid
        responseFormat - the response format
        Returns:
        Response
      • findGeoByTypeAndName

        public javax.ws.rs.core.Response findGeoByTypeAndName(@PathParam(value="storeId")
                                                              java.lang.String storeId)
        Find geo nodes that match the type and the name.
        Parameters:
        storeId - The store ID.
        Returns:
        The response.
      • findByQuery

        @GET
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findByQuery(@PathParam(value="storeId")
                                                                                                                                                                  java.lang.String storeId,
                                                                                                                                                                  @QueryParam(value="q")
                                                                                                                                                                  java.lang.String queryName)
        Find geo nodes based on query name. Supported query name is byGeoNodeTypeAndName.
        Parameters:
        storeId - The store ID.
        queryName - The query name.
        Returns:
        The response.