OSID - osid.resource.GroupNotificationSession Service Interface Definition

Interface	osid.resource.GroupNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Resource` members. 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	getBinId
Description	Gets the `Bin` `Id` associated with this session.
Return	`osid.id.Id`		the `Bin Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBin
Description	Gets the `Bin` associated with this session.
Return	`osid.resource.Bin`		the `Bin` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForGroupNotifications
Description	Tests if this user can register for group 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	useFederatedBinView
Description	Federates the view for methods in this session. A federated view will include resources in bins which are children of this bin in the bin hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBinView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this bin only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableGroupNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeGroupNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableGroupNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeGroupNotification
Description	Acknowledge a group 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	registerForNewMembers
Description	Register for notifications of new resource memberss. `GroupReceiver.newMember()` is invoked when a new member is added to the specified group.
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	registerForDeletedMembers
Description	Register for notifications of deleted resource memberss. `GroupReceiver.deletedMember()` is invoked when a new member is removed from the specified group.
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.