Package org.alfresco.rest.api

Interface Categories

All Known Implementing Classes:
CategoriesImpl
public interface Categories

  • Method Details

    • getCategoryById

      Category getCategoryById(StoreRef storeRef, String id, Parameters parameters)

    • getCategoryById

      default Category getCategoryById(String id, Parameters parameters)

    • createSubcategories

      List<Category> createSubcategories(StoreRef storeRef, String parentCategoryId, List<Category> categories, Parameters parameters)

    • createSubcategories

      default List<Category> createSubcategories(String parentCategoryId, List<Category> categories, Parameters parameters)

    • getCategoryChildren

      List<Category> getCategoryChildren(StoreRef storeRef, String parentCategoryId, Parameters parameters)

    • getCategoryChildren

      default List<Category> getCategoryChildren(String parentCategoryId, Parameters parameters)

    • updateCategoryById

      Category updateCategoryById(StoreRef storeRef, String id, Category fixedCategoryModel, Parameters parameters)
      Update category by ID. Currently, it's possible only to update the name of category.
      Parameters:
      storeRef - Reference to node store.
      id - Category ID.
      fixedCategoryModel - Fixed category model.
      parameters - Additional parameters.
      Returns:
      Updated category.

    • updateCategoryById

      default Category updateCategoryById(String id, Category fixedCategoryModel, Parameters parameters)

    • deleteCategoryById

      void deleteCategoryById(StoreRef storeRef, String id, Parameters parameters)

    • deleteCategoryById

      default void deleteCategoryById(String id, Parameters parameters)

    • listCategoriesForNode

      List<Category> listCategoriesForNode(String nodeId, Parameters parameters)
      Get categories linked from node. Read permission on node is required. Node type is restricted to specified vales from: TypeConstraint.
      Parameters:
      nodeId - Node ID.
      parameters - Additional parameters.
      Returns:
      Categories linked from node.

    • linkNodeToCategories

      List<Category> linkNodeToCategories(StoreRef storeRef, String nodeId, List<Category> categoryLinks, Parameters parameters)
      Link node to categories. Change permission on node is required. Node types allowed for categorization are specified within TypeConstraint.
      Parameters:
      storeRef - Reference to node store.
      nodeId - Node ID.
      categoryLinks - Category IDs to which content should be linked to.
      parameters - Additional parameters.
      Returns:
      Linked to categories.

    • linkNodeToCategories

      default List<Category> linkNodeToCategories(String nodeId, List<Category> categoryLinks, Parameters parameters)

    • unlinkNodeFromCategory

      void unlinkNodeFromCategory(StoreRef storeRef, String nodeId, String categoryId, Parameters parameters)
      Unlink node from a category.
      Parameters:
      storeRef - Reference to node store.
      nodeId - Node ID.
      categoryId - Category ID from which content node should be unlinked from.
      parameters - Additional parameters.

    • unlinkNodeFromCategory

      default void unlinkNodeFromCategory(String nodeId, String categoryId, Parameters parameters)