Interface GroupModifier<T extends Group & MasterEntity>

All Superinterfaces:
Modifier<T>
All Known Subinterfaces:
AgentGroupModifier, SystemGroupModifier

public interface GroupModifier<T extends Group & MasterEntity> extends Modifier<T>
Since:
10.0.108
  • Method Details

    • getName

      String getName()
      Get the current group name which is held in this GroupModifier.
      Returns:
      the name as String
      Since:
      10.0.108
    • setName

      GroupModifier<T> setName(String name) throws ValidationException

      Change the name of the associated Group.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      name - the new name as String
      Returns:
      the GroupModifier
      Throws:
      ValidationException - if the new name is invalid
      Since:
      10.0.108
    • validateName

      boolean validateName(String name) throws ValidationException
      Validate the given name.
      Parameters:
      name - the name to validate as String
      Returns:
      true if the name is valid
      Throws:
      ValidationException - if the name is invalid
      Since:
      10.0.108
    • getDescription

      String getDescription()
      Get the current group description which is held in this GroupModifier.
      Returns:
      the description as String
      Since:
      10.0.108
    • setDescription

      GroupModifier<T> setDescription(String description) throws ValidationException

      Change the description of the associated Group.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      description - the new description as String
      Returns:
      the GroupModifier
      Throws:
      ValidationException - if the new description is invalid
      Since:
      10.0.108
    • validateDescription

      boolean validateDescription(String description) throws ValidationException
      Validate the given description.
      Parameters:
      description - the description to validate as String
      Returns:
      true if the description is valid
      Throws:
      ValidationException - if the description is invalid
      Since:
      10.0.108
    • getAssignedCategories

      Set<Category> getAssignedCategories()
      Get an unmodifiable view of the current assigned categories which are held in this GroupModifier.
      Returns:
      the current assigned categories as an unmodifiable set
      Since:
      10.0.108
    • addAssignedCategories

      GroupModifier<T> addAssignedCategories(Category... categories) throws ValidationException

      Assign the group to the passed categories.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      categories - the categories the group should be assigned to
      Returns:
      the GroupModifier
      Throws:
      ValidationException - if a category is null
      Since:
      10.0.108
    • removeAssignedCategories

      GroupModifier<T> removeAssignedCategories(Category... categories) throws ValidationException

      Remove the assignment of the group to the passed categories.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      categories - the categories for which the assignment should be removed
      Returns:
      the GroupModifier
      Throws:
      ValidationException - if a category is null
      Since:
      10.0.108
    • getParent

      SystemGroup getParent()
      Get the current parent system group which is held in this GroupModifier.
      Returns:
      the parent system group
      Since:
      10.0.108
    • setParent

      GroupModifier<T> setParent(SystemGroup parent) throws ValidationException

      Change the parent system group of the associated Group.

      The change is applied after the Modifier.write() method is called.

      Parameters:
      parent - the new parent system group
      Returns:
      the GroupModifier
      Throws:
      ValidationException - if the new parent is invalid
      Since:
      10.0.108
    • validateParent

      boolean validateParent(SystemGroup parent) throws ValidationException
      Validate the given parent system group.
      Parameters:
      parent - the parent system group to validate
      Returns:
      true if the parent is valid
      Throws:
      ValidationException - if the parent is invalid
      Since:
      10.0.108