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

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

MethodgetCampusId
Description

Gets the Campus Id associated with this session.

Returnosid.id.Idthe Campus Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCampus
Description

Gets the Campus associated with this session.

Returnosid.room.Campusthe campus
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForRenovationNotifications
Description

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

Federates the view for methods in this session. A federated view will include renovations in campuses which are children of this campus in the campus hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCampusView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewRenovations
Description

Register for notifications of new renovations. RenovationReceiver.newRenovations() is invoked when a new Renovation is created.

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

Register for notifications of new renovations for the given room Id. RenovationReceiver.newRenovations() is invoked when a new Renovation is created.

Parametersosid.id.IdroomIdthe Id of the room to monitor
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRenovations
Description

Registers for notification of updated renovations. RenovationReceiver.changedRenovations() is invoked when a renovation is changed.

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

Register for notifications of changed renovations for the given room Id. RenovationReceiver.changedRenovations() is invoked when a Renovation for the room is changed.

Parametersosid.id.IdroomIdthe Id of the room to monitor
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRenovation
Description

Registers for notification of an updated renovation. RenovationReceiver.changedRenovations() is invoked when the specified renovation is changed.

Parametersosid.id.IdrenovationIdthe Id of the Renovation to monitor
ErrorsNULL_ARGUMENT renovationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRenovations
Description

Registers for notification of deleted renovations. RenovationReceiver.deletedRenovations() is invoked when a renovation is deleted.

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

Register for notifications of changed renovations for the given room Id. RenovationReceiver.deletedRenovations() is invoked when a Renovation for the room is deleted.

Parametersosid.id.IdroomIdthe Id of the room to monitor
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRenovation
Description

Registers for notification of a deleted renovation. RenovationReceiver.deletedRenovations() is invoked when the specified renovation is deleted.

Parametersosid.id.IdrenovationIdthe Id of the Renovation to monitor
ErrorsNULL_ARGUMENT renovationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.