OSID - osid.offering.ParticipantNotificationSession Service Interface Definition

Interface	osid.offering.ParticipantNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Participants`. 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.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForParticipantNotifications
Description	Tests if this user can register for `Participant` 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	useFederatedCatalogueView
Description	Federates the view for methods in this session. A federated view will include notifications for participants in catalogues which are children of this catalogue in the catalogue hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogueView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableParticipantNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeParticipantNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableParticipantNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeParticipantNotification
Description	Acknowledge a participant 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	registerForNewParticipants
Description	Register for notifications of new participants. `ParticipantReceiver.newParticipants()` is invoked when a new `Participant` is appears in this catalogue.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewParticipantsForOffering
Description	Register for notifications of new participants for an offering. `ParticipantReceiver.newParticipants()` is invoked when a new `Participant` appears in this catalogue.
Parameters	`osid.id.Id`	`offeringId`	an offering to monitor
Errors	NULL_ARGUMENT		`offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewParticipantsForResource
Description	Register for notifications of new participants for a resource. `ParticipantReceiver.newParticipants()` is invoked when a new `Participant` appears in this catalogue.
Parameters	`osid.id.Id`	`resourceId`	a 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	registerForChangedParticipants
Description	Registers for notification of updated participants. `ParticipantReceiver.changedParticipants()` is invoked when a participant in this catalogue is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedParticipantsForOffering
Description	Register for notifications of changed participants for the given offering. `ParticipantReceiver.changedParticipants()` is invoked when a `Participant` for the offering in this catalogue is changed.
Parameters	`osid.id.Id`	`offeringId`	an offering to monitor
Errors	NULL_ARGUMENT		`offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedParticipantsForResource
Description	Register for notifications of changed participants for the given resource. `ParticipantReceiver.changedParticipants()` is invoked when a `Participant` for the offering in this catalogue is changed.
Parameters	`osid.id.Id`	`resourceId`	a 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	registerForChangedParticipant
Description	Registers for notification of an updated participant. `ParticipantReceiver.changedParticipants()` is invoked when the specified participant in this catalogue is changed.
Parameters	`osid.id.Id`	`participantId`	the `Id` of the `Participant` to monitor
Errors	NOT_FOUND		a participant was not found identified by the given `Id`
	NULL_ARGUMENT		`participantId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedParticipants
Description	Registers for notification of deleted participants. `ParticipantReceiver.deletedParticipants()` is invoked when a participant is removed from this catalogue.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedParticipantsForOffering
Description	Register for notifications of deleted participants for the given offering. `ParticipantReceiver.deletedParticipants()` is invoked when a `Participant` for the offering is removed from this catalogue.
Parameters	`osid.id.Id`	`offeringId`	an offering to monitor
Errors	NULL_ARGUMENT		`offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedParticipantsForResource
Description	Register for notifications of deleted participants for the given resource. `ParticipantReceiver.deletedParticipants()` is invoked when a `Participant` for the offering is removed from this catalogue.
Parameters	`osid.id.Id`	`resourceId`	a 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	registerForDeletedParticipant
Description	Registers for notification of a deleted participants. `ParticipantReceiver.deletedParticipants()` is invoked when the specified participant is removed from this catalogue.
Parameters	`osid.id.Id`	`participantId`	the `Id` of the `Participant` to monitor
Errors	NOT_FOUND		a participant was not found identified by the given `Id`
	NULL_ARGUMENT		`participantId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.