OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.CampusNotificationSession
Implementsosid.OsidSession
Description

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

Returnboolean false if notification methods are not authorized, true otherwise
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.
MethodregisterForNewCampusAncestors
Description

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified campus. CampusReceiver.newAncestorCampuses() is invoked when the specified campus node gets a new ancestor.

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

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified campus. CampusReceiver.newDescendantCampus() is invoked when the specified campus node gets a new descendant.

Parametersosid.id.IdcampusIdthe Id of the Campus node to monitor
ErrorsNULL_ARGUMENT campusId is null
OPERATION_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_ARGUMENT campusId 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_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCampusAncestors
Description

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified campus CampusReceiver.deletedAncestor() is invoked when the specified campus node loses an ancestor.

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

Registers for notification of an updated hierarchy structure that removes a descendant of the specified campus. CampusReceiver.deletedDescendant() is invoked when the specified campus node loses a descendant.

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