Interface BuildingCampusAssignmentSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface BuildingCampusAssignmentSession extends OsidSession

This session provides methods to re-assign Buildings to Campuses . A Building may map to multiple Campuses and removing the last reference to a Building is the equivalent of deleting it. Each Campus may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Building to another Campus is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignBuildings

      boolean canAssignBuildings()
      Tests if this user can alter building/campus mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignBuildingsToCampus

      boolean canAssignBuildingsToCampus(Id campusId)
      Tests if this user can alter building/campus mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Parameters:
      campusId - the Id of the Campus
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - campusId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableCampusIds

      IdList getAssignableCampusIds(Id campusId) throws OperationFailedException
      Gets a list of campuses including and under the given campus node in which any building can be assigned.
      Parameters:
      campusId - the Id of the Campus
      Returns:
      list of assignable campus Ids
      Throws:
      NullArgumentException - campusId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableCampusIdsForBuilding

      IdList getAssignableCampusIdsForBuilding(Id campusId, Id buildingId) throws OperationFailedException
      Gets a list of campuses including and under the given campus node in which a specific building can be assigned.
      Parameters:
      campusId - the Id of the Campus
      buildingId - the Id of the Building
      Returns:
      list of assignable campus Ids
      Throws:
      NullArgumentException - campusId or buildingId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignBuildingToCampus

      void assignBuildingToCampus(Id buildingId, Id campusId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing Building to a Campus .
      Parameters:
      buildingId - the Id of the Building
      campusId - the Id of the Campus
      Throws:
      AlreadyExistsException - buildingId is already assigned to campusId
      NotFoundException - buildingId or campusId not found
      NullArgumentException - buildingId or campusId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignBuildingFromCampus

      void unassignBuildingFromCampus(Id buildingId, Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a Building from a Campus .
      Parameters:
      buildingId - the Id of the Building
      campusId - the Id of the Campus
      Throws:
      NotFoundException - buildingId or campusId not found or buildingId not assigned to campusId
      NullArgumentException - buildingId or campusId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignBuildingToCampus

      void reassignBuildingToCampus(Id buildingId, Id fromCampusId, Id toCampusId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a Building from one Campus to another. Mappings to other Campuses are unaffected.
      Parameters:
      buildingId - the Id of the Building
      fromCampusId - the Id of the current Campus
      toCampusId - the Id of the destination Campus
      Throws:
      AlreadyExistsException - buildingId , already assigned to toCampusId
      NotFoundException - buildingId, fromCampusId , or toCampusId not found or buildingId not mapped to fromCampusId
      NullArgumentException - buildingId, fromCampusId , or toCampusId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.