com.ibm.commerce.rest.pagelayout.handler

Class PageHandler

    • Field Detail

      • COPYRIGHT

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

      • PageHandler

        public PageHandler()
    • 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
      • findByPageId

        @GET
         @Path(value="{pageId}")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findByPageId(@PathParam(value="storeId")
                                                                                                                                                                                            java.lang.String storeId,
                                                                                                                                                                                            @PathParam(value="pageId")
                                                                                                                                                                                            java.lang.String pageId)
        Finds a page by its ID.
        Parameters:
        storeId - The store ID.
        pageId - The page ID.
        Returns:
        The response.
      • findByName

        @GET
         @Path(value="name/{name}")
         @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
        public javax.ws.rs.core.Response findByName(@PathParam(value="storeId")
                                                                                                                                                                                             java.lang.String storeId,
                                                                                                                                                                                             @PathParam(value="name")
                                                                                                                                                                                             java.lang.String name)
        Finds a page by its name.
        Parameters:
        storeId - The store ID.
        name - The page name.
        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)
        Finds pages by a query. See each query for details on input and output.
        Parameters:
        storeId - The store ID.
        queryName - The query name.
        Returns:
        The response.
      • byPageIds

        public javax.ws.rs.core.Response byPageIds(@PathParam(value="storeId")
                                                   java.lang.String storeId)
        Finds pages by their IDs. Invalid page IDs are ignored.
        Parameters:
        storeId - The store ID.
        Returns:
        The response.
      • byNames

        public javax.ws.rs.core.Response byNames(@PathParam(value="storeId")
                                                 java.lang.String storeId)
        Finds pages by their names. Invalid page names are ignored.
        Parameters:
        storeId - The store ID.
        Returns:
        The response.
      • byUrlConfigurable

        public javax.ws.rs.core.Response byUrlConfigurable(@PathParam(value="storeId")
                                                           java.lang.String storeId)
        Finds content pages with or without configurable URLs.
        Parameters:
        storeId - The store ID.
        Returns:
        The response.
      • byCatalogEntryIds

        public javax.ws.rs.core.Response byCatalogEntryIds(@PathParam(value="storeId")
                                                           java.lang.String storeId)
        Finds pages by catalog entry IDs. Invalid catalog entry IDs are ignored.
        Parameters:
        storeId - The store ID.
        Returns:
        The response.
      • byCategoryIds

        public javax.ws.rs.core.Response byCategoryIds(@PathParam(value="storeId")
                                                       java.lang.String storeId)
        Finds pages by category IDs. Invalid category IDs are ignored.
        Parameters:
        storeId - The store ID.
        Returns:
        The response.