OSID Logo
OSID Specifications
room package
Version 3.0.0
Interfaceosid.room.CampusNotificationSession
Implementsosid.OsidSession
Used Byosid.room.RoomManager
osid.room.RoomProxyManager
Description

This session defines methods to receive notifications on adds/changes to Campuses . 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 Campus object itself. Adding and removing rooms result in notifications available from the notification session for rooms.

MethodcanRegisterForCampusNotifications
Description

Tests if this user can register for Campus 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.

Returnbooleanfalse if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableCampusNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeCampusNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableCampusNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCampusNotification
Description

Acknowledge a campus notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCampuses
Description

Register for notifications of new campuses. CampusReceiver.newCampuses() is invoked when a new Campus is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCampuses
Description

Registers for notification of updated campuses. CampusReceiver.changedCampus() is invoked when a campus is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCampus
Description

Registers for notification of an updated campus. CampusReceiver.changedCampuses() is invoked when the specified campus is changed.

Parametersosid.id.IdcampusIdthe Id of the Campus to monitor
ErrorsNULL_ARGUMENTcampusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCampuses
Description

Registers for notification of deleted campuses. CampusReceiver.deletedCampuses() is invoked when a campus is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCampus
Description

Registers for notification of a deleted campus. CampusReceiver.deletedCampuses() is invoked when the specified campus is deleted.

Parametersosid.id.IdcampusIdthe Id of the Campus to monitor
ErrorsNULL_ARGUMENTcampusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCampusHierarchy
Description

Registers for notification of an updated campus hierarchy structure. CampusReceiver.changedChildOfCampuses() is invoked when the specified node or any of its descendants experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCampusHierarchyForAncestors
Description

Registers for notification of an updated campus hierarchy structure. CampusReceiver.changedChildOfCampuses() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdcampusIdthe Id of the Campus node to monitor
ErrorsNULL_ARGUMENTcampusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCampusHierarchyForDescendants
Description

Registers for notification of an updated campus hierarchy structure. CampusReceiver.changedChildOfCampuses() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdcampusIdthe Id of the Campus node to monitor
ErrorsNULL_ARGUMENTcampusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.