org.osid.room

Interface BuildingNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BuildingNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Building objects. 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 Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForBuildingNotifications() Tests if this user can register for Building notifications.
Campus	getCampus() Gets the Campus associated with this session.
Id	getCampusId() Gets the Campus Id associated with this session.
void	registerForChangedBuilding(Id buildingId) Registers for notification of an updated building.
void	registerForChangedBuildings() Registers for notification of updated buildings.
void	registerForDeletedBuilding(Id buildingId) Registers for notification of a deleted building.
void	registerForDeletedBuildings() Registers for notification of deleted buildings.
void	registerForNewBuildings() Register for notifications of new buildings.
void	useFederatedCampusView() Federates the view for methods in this session.
void	useIsolatedCampusView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

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.