Package com.hybris.merchandising.client

Interface MerchCatalogServiceProductDirectoryClient

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.hybris.charon.RawResponse createProductDirectory​(ProductDirectory productDirectory)
      createProductDirectory is a method for creating a product directory and synchronising with CDS.
      rx.Observable<com.hybris.charon.RawResponse> createProductDirectoryAsync​(ProductDirectory productDirectory)
      createProductDirectoryAsync is a method for creating a product directory and synchronising with CDS.
      java.lang.Void deleteProductDirectory​(java.lang.String productDirectoryId)
      deleteProductDirectory is a method for deleting an existing product directory and synchronising with CDS.
      rx.Observable<java.lang.Void> deleteProductDirectoryAsync​(java.lang.String productDirectoryId)
      deleteProductDirectoryAsync is a method for deleting an existing product directory and synchronising with CDS.
      java.lang.String handleCategories​(java.lang.String productDirectoryId, CategoryHierarchyWrapper categories)
      handleCategories is a method for sending categories to CDS.
      rx.Observable<java.lang.String> handleCategoriesAsync​(java.lang.String productDirectoryId, CategoryHierarchyWrapper categories)
      handleCategoriesAsync is an asynchronous method for sending categories to CDS.
      java.lang.String handleProductsBatch​(java.lang.String productDirectoryId, java.lang.Long version, java.util.List<Product> products)
      handleProductsBatch is a handler for accepting a batch of products and sending them to the Merchandising Catalog service.
      java.lang.Void handleProductsBatch​(java.lang.String productDirectoryId, java.util.List<Product> products)
      handleProductsBatch is a handler for accepting a batch of products and sending them to the Merchandising Catalog service.
      rx.Observable<java.lang.String> handleProductsBatchAsync​(java.lang.String productDirectoryId, java.lang.Long version, java.util.List<Product> products)
      handleProductsBatchAsync is a handler for accepting a batch of products and sending them to the Merchandising Catalog service.
      rx.Observable<java.lang.Void> handleProductsBatchAsync​(java.lang.String productDirectoryId, java.util.List<Product> products)
      handleProductsBatchAsync is a handler for accepting a batch of products and sending them to the Merchandising Catalog service.
      java.lang.Void publishProducts​(java.lang.String productDirectoryId, java.lang.Long version)
      publishProducts is an API for marking a set of products as being published to live in a synchronous manner.
      rx.Observable<java.lang.Void> publishProductsAsync​(java.lang.String productDirectoryId, java.lang.Long version)
      publishProductsAsync is an API for marking a set of products as being published to live in an asynchronous manner.
      java.lang.Void updateProductDirectory​(java.lang.String productDirectoryId, ProductDirectory productDirectory)
      updateProductDirectory is a method for updating an existing product directory and synchronising with CDS.
      rx.Observable<java.lang.Void> updateProductDirectoryAsync​(java.lang.String productDirectoryId, ProductDirectory productDirectory)
      updateProductDirectoryAsync is a method for updating an existing product directory and synchronising with CDS.

    • Method Detail

      • handleProductsBatch

        @POST
@Produces("application/json")
@Path("/${tenant}/productdirectories/{productDirectoryId}/products/versions/{versionId}")
java.lang.String handleProductsBatch​(@PathParam("productDirectoryId")
                                     java.lang.String productDirectoryId,
                                     @PathParam("versionId")
                                     java.lang.Long version,
                                     java.util.List<Product> products)
        handleProductsBatch is a handler for accepting a batch of products and sending them to the Merchandising Catalog service.
        Parameters:
        productDirectoryId - - the product directory ID we wish to associate the products with.
        version - the version to send the products as.
        products - a list of products to send.
        Returns:
        String - ID of the operation.

      • handleProductsBatch

        @PUT
@Produces("application/json")
@Path("/${tenant}/productdirectories/{productDirectoryId}/products")
java.lang.Void handleProductsBatch​(@PathParam("productDirectoryId")
                                   java.lang.String productDirectoryId,
                                   java.util.List<Product> products)
        handleProductsBatch is a handler for accepting a batch of products and sending them to the Merchandising Catalog service.
        Parameters:
        productDirectoryId - - the product directory ID we wish to associate the products with.
        products - a list of products to send.
        Returns:
        String - ID of the operation.

      • handleProductsBatchAsync

        @PUT
@Produces("application/json")
@Path("/${tenant}/productdirectories/{productDirectoryId}/products")
rx.Observable<java.lang.Void> handleProductsBatchAsync​(@PathParam("productDirectoryId")
                                                       java.lang.String productDirectoryId,
                                                       java.util.List<Product> products)
        handleProductsBatchAsync is a handler for accepting a batch of products and sending them to the Merchandising Catalog service.
        Parameters:
        productDirectoryId - - the product directory ID we wish to associate the products with.
        products - a list of products to send.
        Returns:
        String - ID of the operation.

      • handleProductsBatchAsync

        @POST
@Produces("application/json")
@Path("/${tenant}/productdirectories/{productDirectoryId}/products/versions/{versionId}")
rx.Observable<java.lang.String> handleProductsBatchAsync​(@PathParam("productDirectoryId")
                                                         java.lang.String productDirectoryId,
                                                         @PathParam("versionId")
                                                         java.lang.Long version,
                                                         java.util.List<Product> products)
        handleProductsBatchAsync is a handler for accepting a batch of products and sending them to the Merchandising Catalog service.
        Parameters:
        productDirectoryId - - the product directory ID we wish to associate the products with.
        version - the version to send the products as.
        products - a list of products to send.
        Returns:
        String - ID of the operation.

      • publishProducts

        @POST
@Produces("application/json")
@Path("/${tenant}/productdirectories/{productDirectoryId}/products/versions/{versionId}/publish")
java.lang.Void publishProducts​(@PathParam("productDirectoryId")
                               java.lang.String productDirectoryId,
                               @PathParam("versionId")
                               java.lang.Long version)
        publishProducts is an API for marking a set of products as being published to live in a synchronous manner.
        Parameters:
        productDirectoryId - - the product directory ID we wish to associate the products with.
        version - the version to publish.
        Returns:
        Void.

      • publishProductsAsync

        @POST
@Produces("application/json")
@Path("/${tenant}/productdirectories/{productDirectoryId}/products/versions/{versionId}/publish")
rx.Observable<java.lang.Void> publishProductsAsync​(@PathParam("productDirectoryId")
                                                   java.lang.String productDirectoryId,
                                                   @PathParam("versionId")
                                                   java.lang.Long version)
        publishProductsAsync is an API for marking a set of products as being published to live in an asynchronous manner.
        Parameters:
        productDirectoryId - - the product directory ID we wish to associate the products with.
        version - the version to publish.
        Returns:
        an Observable containing Void.

      • handleCategoriesAsync

        @POST
@Produces("application/json")
@Path("/${tenant}/productdirectories/{productDirectoryId}/categories")
rx.Observable<java.lang.String> handleCategoriesAsync​(@PathParam("productDirectoryId")
                                                      java.lang.String productDirectoryId,
                                                      CategoryHierarchyWrapper categories)
        handleCategoriesAsync is an asynchronous method for sending categories to CDS.
        Parameters:
        productDirectoryId - - the product directory ID we wish to associate the categories with.
        categories - the CategoryHierarchyWrapper object to publish.
        Returns:
        an Observable containing the response.

      • handleCategories

        @POST
@Produces("application/json")
@Path("/${tenant}/productdirectories/{productDirectoryId}/categories")
java.lang.String handleCategories​(@PathParam("productDirectoryId")
                                  java.lang.String productDirectoryId,
                                  CategoryHierarchyWrapper categories)
        handleCategories is a method for sending categories to CDS.
        Parameters:
        productDirectoryId - - the product directory ID we wish to associate the categories with.
        categories - the CategoryHierarchyWrapper object to publish.
        Returns:
        String - ID of the operation.

      • createProductDirectoryAsync

        @POST
@Produces("application/json")
@Path("/${tenant}/productdirectories")
rx.Observable<com.hybris.charon.RawResponse> createProductDirectoryAsync​(ProductDirectory productDirectory)
        createProductDirectoryAsync is a method for creating a product directory and synchronising with CDS.
        Parameters:
        productDirectory - the ProductDirectory we wish to create.
        Returns:
        Observable representing the RawResponse of the operation.

      • createProductDirectory

        @POST
@Produces("application/json")
@Path("/${tenant}/productdirectories")
com.hybris.charon.RawResponse createProductDirectory​(ProductDirectory productDirectory)
        createProductDirectory is a method for creating a product directory and synchronising with CDS.
        Parameters:
        productDirectory - the ProductDirectory we wish to create.
        Returns:
        a RawResponse representing the response of the operation.

      • updateProductDirectoryAsync

        @PUT
@Path("/${tenant}/productdirectories/{productDirectoryId}")
@Produces("application/json")
rx.Observable<java.lang.Void> updateProductDirectoryAsync​(@PathParam("productDirectoryId")
                                                          java.lang.String productDirectoryId,
                                                          ProductDirectory productDirectory)
        updateProductDirectoryAsync is a method for updating an existing product directory and synchronising with CDS.
        Parameters:
        productDirectoryId - the ID of the ProductDirectory to update.
        productDirectory - the ProductDirectory to update.
        Returns:
        an Observable containing Void.

      • updateProductDirectory

        @PUT
@Path("/${tenant}/productdirectories/{productDirectoryId}")
@Produces("application/json")
java.lang.Void updateProductDirectory​(@PathParam("productDirectoryId")
                                      java.lang.String productDirectoryId,
                                      ProductDirectory productDirectory)
        updateProductDirectory is a method for updating an existing product directory and synchronising with CDS.
        Parameters:
        productDirectoryId - the ID of the ProductDirectory to update.
        productDirectory - the ProductDirectory to update.
        Returns:
        Void.

      • deleteProductDirectoryAsync

        @DELETE
@Path("/${tenant}/productdirectories/{productDirectoryId}")
@Produces("application/json")
rx.Observable<java.lang.Void> deleteProductDirectoryAsync​(@PathParam("productDirectoryId")
                                                          java.lang.String productDirectoryId)
        deleteProductDirectoryAsync is a method for deleting an existing product directory and synchronising with CDS.
        Parameters:
        productDirectoryId - the ID of the ProductDirectory to delete.
        Returns:
        an Observable containing Void.

      • deleteProductDirectory

        @DELETE
@Path("/${tenant}/productdirectories/{productDirectoryId}")
@Produces("application/json")
java.lang.Void deleteProductDirectory​(@PathParam("productDirectoryId")
                                      java.lang.String productDirectoryId)
        deleteProductDirectory is a method for deleting an existing product directory and synchronising with CDS.
        Parameters:
        productDirectoryId - the ID of the ProductDirectory to delete.
        Returns:
        Void.