OSID Logo
OSID Specifications
room construction package
Version 3.1.0
Interfaceosid.room.construction.RenovationNotificationSession
Implementsosid.OsidSession
Used Byosid.room.construction.RoomConstructionManager
osid.room.construction.RoomConstructionProxyManager
Description

This session defines methods to receive notifications on adds/changes to Renovations. 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.Id the Campus Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetCampus
Description

Gets the Campus associated with this session.

Returnosid.room.Campus the campus
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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
Compliancemandatory This 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.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedCampusView
Description

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

Compliancemandatory This method is must be implemented.
MethodreliableRenovationNotifications
Description

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

Compliancemandatory This method is must be implemented.
MethodunreliableRenovationNotifications
Description

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

Compliancemandatory This method is must be implemented.
MethodacknowledgeRenovationNotification
Description

Acknowledge a renovation notification.

Parametersosid.id.IdnotificationId the Id of the notification
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForNewRenovations
Description

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

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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.IdroomId the Id of the room to monitor
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForChangedRenovations
Description

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

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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.IdroomId the Id of the room to monitor
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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.IdrenovationId the Id of the Renovation to monitor
ErrorsNULL_ARGUMENT renovationId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodregisterForDeletedRenovations
Description

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

ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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.IdroomId the Id of the room to monitor
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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.IdrenovationId the Id of the Renovation to monitor
ErrorsNULL_ARGUMENT renovationId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.