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

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

Tests if this user can register for Project 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 projects 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.
MethodregisterForNewProjects
Description

Register for notifications of new projects. ProjectReceiver.newProjects() is invoked when a new Project is created.

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

Registers for notification of new projects for a building. ProjectReceiver.newProjects() is invoked when a project for the building is created.

Parametersosid.id.IdbuildingIdthe Id of the Building to monitor
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProjects
Description

Registers for notification of updated projects. ProjectReceiver.changedProjects() is invoked when a project is changed.

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

Registers for notification of a updated projectsfor a building. ProjectReceiver.changedProjects() is invoked when a project for the building is changed.

Parametersosid.id.IdbuildingIdthe Id of the Building to monitor
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProject
Description

Registers for notification of an updated project. ProjectReceiver.changedProjects() is invoked when the specified project is changed.

Parametersosid.id.IdprojectIdthe Id of the Project to monitor
ErrorsNULL_ARGUMENT projectId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProjects
Description

Registers for notification of deleted projects. ProjectReceiver.deletedProjects() is invoked when a project is deleted.

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

Registers for notification of a deleted project for a building. ProjectReceiver.deletedProjects() is invoked when a project for the building is deleted.

Parametersosid.id.IdbuildingIdthe Id of the Building to monitor
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProject
Description

Registers for notification of a deleted project. ProjectReceiver.deletedProjects() is invoked when the specified project is deleted.

Parametersosid.id.IdprojectIdthe Id of the Project to monitor
ErrorsNULL_ARGUMENT projectId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.