Interface BuildingNotificationSession

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

This session defines methods to receive notifications on adds/changes to Buildings . This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

Notifications are triggered with changes to the Building object itself. Adding and removing rooms result in notifications available from the notification session for rooms.

  • Method Details

    • getCampusId

      Id getCampusId()
      Gets the Campus Id associated with this session.
      Returns:
      the Campus Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCampus

      Campus getCampus() throws OperationFailedException, PermissionDeniedException
      Gets the Campus associated with this session.
      Returns:
      the campus
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForBuildingNotifications

      boolean canRegisterForBuildingNotifications()
      Tests if this user can register for Building notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 notification operations.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedCampusView

      void useFederatedCampusView()
      Federates the view for methods in this session. A federated view will include buildings in campuses which are children of this campus in the campus hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCampusView

      void useIsolatedCampusView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableBuildingNotifications

      void reliableBuildingNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeBuildingNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableBuildingNotifications

      void unreliableBuildingNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeBuildingNotification

      void acknowledgeBuildingNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a building notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewBuildings

      void registerForNewBuildings() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new buildings. BuildingReceiver.newBuildings() is invoked when a new Building is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBuildings

      void registerForChangedBuildings() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated buildings. BuildingReceiver.changedBuildings() is invoked when a building is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBuilding

      void registerForChangedBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated building. BuildingReceiver.changedBuildings() is invoked when the specified building is changed.
      Parameters:
      buildingId - the Id of the Building to monitor
      Throws:
      NullArgumentException - buildingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedBuildings

      void registerForDeletedBuildings() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted buildings. BuildingReceiver.deletedBuildings() is invoked when a building is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedBuilding

      void registerForDeletedBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted building. BuildingReceiver.deletedBuildings() is invoked when the specified building is deleted.
      Parameters:
      buildingId - the Id of the Building to monitor
      Throws:
      NullArgumentException - buildingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.