OSID - osid.room.squatting.DeedNotificationSession Service Interface Definition

Interface	osid.room.squatting.DeedNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.room.squatting.RoomSquattingManager`
Used By	`osid.room.squatting.RoomSquattingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Deeds`. 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 `Deed` 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	canRegisterForDeedNotifications
Description	Tests if this user can register for `Deed` 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 deeds 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	reliableDeedNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeDeedNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableDeedNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeDeedNotification
Description	Acknowledge a deed 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	registerForNewDeeds
Description	Register for notifications of new deeds. `DeedReceiver.newDeeds()` is invoked when a new `Deed` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewDeedsForBuilding
Description	Registers for notification of new deeds for a building. `DeedReceiver.newDeeds()` is invoked when a deed 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	registerForNewDeedsForOwner
Description	Registers for notification of new deeds for an owner. `DeedReceiver.NewDeeds()` is invoked when a deed for the owner is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDeeds
Description	Registers for notification of updated deeds. `DeedReceiver.changedDeeds()` is invoked when a deed is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDeedsForBuilding
Description	Registers for notification of a updated deedsfor a building. `DeedReceiver.changedDeeds()` is invoked when a deed 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	registerForChangedDeedsForOwner
Description	Registers for notification of updated deeds for an owner. `DeedReceiver.changedDeeds()` is invoked when a deed for the owner is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDeed
Description	Registers for notification of an updated deed. `DeedReceiver.changedDeeds()` is invoked when the specified deed is changed.
Parameters	`osid.id.Id`	`deedId`	the `Id` of the `Deed` to monitor
Errors	NULL_ARGUMENT		`deedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDeeds
Description	Registers for notification of deleted deeds. `DeedReceiver.deletedDeeds()` is invoked when a deed is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDeedsForBuilding
Description	Registers for notification of a deleted deed for a building. `DeedReceiver.deletedDeeds()` is invoked when a deed 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	registerForDeletedDeedsForOwner
Description	Registers for notification of a deleted deed for an owner. `DeedReceiver.deletedDeeds()` is invoked when a deed for the owner is deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDeed
Description	Registers for notification of a deleted deed. `DeedReceiver.deletedDeeds()` is invoked when the specified deed is deleted.
Parameters	`osid.id.Id`	`deedId`	the `Id` of the `Deed` to monitor
Errors	NULL_ARGUMENT		`deedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.