OSID - osid.room.construction.ProjectNotificationSession Service Interface Definition

Interface	osid.room.construction.ProjectNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.room.construction.RoomConstructionManager`
Used By	`osid.room.construction.RoomConstructionProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Projects`. 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.
Method	getCampusId
Description	Gets the `Campus` `Id` associated with this session.
Return	`osid.id.Id`		the `Campus Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCampus
Description	Gets the `Campus` associated with this session.
Return	`osid.room.Campus`		the campus
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForProjectNotifications
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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCampusView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCampusView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableProjectNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeProjectNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableProjectNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeProjectNotification
Description	Acknowledge a project notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProjects
Description	Register for notifications of new projects. `ProjectReceiver.newProjects()` is invoked when a new `Project` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProjectsByBuilding
Description	Registers for notification of new projects for a building. `ProjectReceiver.newProjects()` is invoked when a project for the building is created.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the `Building` to monitor
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProjects
Description	Registers for notification of updated projects. `ProjectReceiver.changedProjects()` is invoked when a project is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProjectsByBuilding
Description	Registers for notification of a updated projectsfor a building. `ProjectReceiver.changedProjects()` is invoked when a project for the building is changed.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the `Building` to monitor
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProject
Description	Registers for notification of an updated project. `ProjectReceiver.changedProjects()` is invoked when the specified project is changed.
Parameters	`osid.id.Id`	`projectId`	the `Id` of the `Project` to monitor
Errors	NULL_ARGUMENT		`projectId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProjects
Description	Registers for notification of deleted projects. `ProjectReceiver.deletedProjects()` is invoked when a project is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProjectsByBuilding
Description	Registers for notification of a deleted project for a building. `ProjectReceiver.deletedProjects()` is invoked when a project for the building is deleted.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the `Building` to monitor
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProject
Description	Registers for notification of a deleted project. `ProjectReceiver.deletedProjects()` is invoked when the specified project is deleted.
Parameters	`osid.id.Id`	`projectId`	the `Id` of the `Project` to monitor
Errors	NULL_ARGUMENT		`projectId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.