Interface CategoryPlugin


public interface CategoryPlugin
  • Method Details

    • getType

      String getType()
      Returns:
      The managed Object Type (Space, Activity...)
    • canAccess

      boolean canAccess(String objectId, String username)
      Checks whether an associated object to a category is accessible to a user. This check will be called after checking whether the user can access or not to the category (generic ACL check made in Category API switch Category properties)
      Parameters:
      objectId - Object technical identifier
      username - User technical name (login identifier)
      Returns:
      true if the user has access permission to the designated Object Type
    • canEdit

      boolean canEdit(String objectId, String username)
      Checks whether an associated object to a category is editable to a user. This check will be used mainly used to know if a user can modify the object in order to associate/link a category into it. This check will be called after checking whether the user can link or not an object to the category (generic ACL check made in Category API switch Category properties)
      Parameters:
      objectId - Object technical identifier
      username - User technical name (login identifier)
      Returns:
      true if the user has access permission to the designated Object Type identified by its Id
    • getCategoryIds

      default List<Long> getCategoryIds()
      Returns:
      List of Category Ids associated to objects
    • getCategoryIds

      default List<Long> getCategoryIds(long spaceId)
      param spaceId Space Identifier
      Returns:
      List of Category Ids associated to objects switch designated spaceId
    • getObject

      default CategoryObject getObject(CategoryObject metadataObject)