All Known Implementing Classes:
DefaultOrgUnitService

public interface OrgUnitService
Service interface for organizational unit related operations.
Since:
6.1
  • Method Details

    • createUnit

      void createUnit(OrgUnitParameter parameter)
      Create a new organizational unit.
      Parameters:
      parameter - Extensible OrgUnitParameter bean containing the initial attributes of the organizational unit to be created. Mandatory values:
      • OrgUnitParameter.uid
      • OrgUnitParameter.name
      • OrgUnitParameter.active
    • createAndGetUnit

      default Optional<OrgUnitModel> createAndGetUnit(OrgUnitParameter parameter)
      Create a new organizational unit and get the created object in response
      Parameters:
      parameter - Extensible OrgUnitParameter bean containing the initial attributes of the organizational unit to be created. Mandatory values:
      • OrgUnitParameter.uid
      • OrgUnitParameter.name
      • OrgUnitParameter.active
      Returns:
      An Optional which
      • contains the OrgUnitModel if created and
      • is empty otherwise.
    • updateUnit

      void updateUnit(OrgUnitParameter parameter)
      Update an existing organizational unit.
      Parameters:
      parameter - Extensible OrgUnitParameter bean containing the initial attributes of the organizational unit to be updated. Mandatory values:
      • OrgUnitParameter.orgUnit
    • getUnitForUid

      Optional<OrgUnitModel> getUnitForUid(String uid)
      Get the organizational unit with the given uid.
      Parameters:
      uid - the uid of the organizational unit
      Returns:
      An Optional which
      • contains the OrgUnitModel for the given uid if it exists and
      • is empty otherwise.
    • activateUnit

      void activateUnit(OrgUnitModel orgUnit)
      Activate the organizational unit with the given orgUnit.
      Parameters:
      orgUnit - the organizational unit
    • deactivateUnit

      void deactivateUnit(OrgUnitModel orgUnit)
      Deactivate the organizational unit and all of its child units with the given orgUnit.
      Parameters:
      orgUnit - the organizational unit
    • addMembers

      void addMembers(OrgUnitMemberParameter parameter)
      Add one or more members to a organizational unit.
      Parameters:
      parameter - Extensible OrgUnitMemberParameter bean holding the method parameters. Mandatory values:
      • OrgUnitMemberParameter.uid
      • OrgUnitMemberParameter.type
      • OrgUnitMemberParameter.members
    • removeMembers

      void removeMembers(OrgUnitMemberParameter parameter)
      Remove one or more members from a organizational unit.
      Parameters:
      parameter - Extensible OrgUnitMemberParameter bean holding the method parameters. Mandatory values:
      • OrgUnitMemberParameter.uid
      • OrgUnitMemberParameter.type
      • OrgUnitMemberParameter.members
    • getMembers

      <T extends PrincipalModel> SearchPageData<T> getMembers(OrgUnitMemberParameter<T> parameter)
      Get a paged search result for members of the given organizational unit.
      Parameters:
      parameter - Extensible OrgUnitMemberParameter bean holding the method parameters. Mandatory values:
      • OrgUnitMemberParameter.uid
      • OrgUnitMemberParameter.type
      • OrgUnitMemberParameter.members
      Returns:
      SearchPageData containing the paged search result for members of the given organizational unit
    • getParent

      Optional<OrgUnitModel> getParent(OrgUnitModel orgUnit)
      Gets the parent unit of a unit.
      Parameters:
      orgUnit - the organizational unit
      Returns:
      An Optional which
      • contains the parent OrgUnitModel for the given unit's uid if it exists and
      • is empty if unit was the root unit.
    • getRolesForEmployee

      Set<PrincipalGroupModel> getRolesForEmployee(EmployeeModel employee)
      Get a list of user roles that the given employee belongs to
      Parameters:
      employee - the employee model to search its belonging user roles
      Returns:
      a list of user group which represents user role