OSID - osid.resource.ResourceRelationshipNotificationSession Service Interface Definition

Interface	osid.resource.ResourceRelationshipNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
Description	This session defines methods to receive asynchronous notifications on adds/changes to resource relationships. 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. The views defined in this session correspond to the views in the `ResourceRelationshipLookupSession`.
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForResourceRelationshipNotifications
Description	Tests if this user can register for `ResourceRelationship` 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 notifications for relationships 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 for relationships in this bin only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableResourceRelationshipNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeResourceRelationshipNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableResourceRelationshipNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeResourceRelationshipNotification
Description	Acknowledge a resource relationship 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	registerForNewResourceRelationships
Description	Register for notifications of new relationship. `ResourceRelationshipReceiver.newResourceRelationships()` is invoked when a new relationship is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewResourceRelationshipsByGenusType
Description	Register for notifications of new relationships of the given genus type. `ResourceRelationshipReceiver.newResourceRelationships()` is invoked when a new relationship is created.
Parameters	`osid.type.Type`	`resourceRelationshipGenusType`	the rsource relationship genus type
Errors	NULL_ARGUMENT		`resourceRelationshipGenusType is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewResourceRelationshipsForSourceResource
Description	Register for notifications of new relationships from the given resource. `ResourceRelationshipReceiver.newResourceRelationships()` is invoked when a new relationship 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	registerForNewResourceRelationshipsForDestinationResource
Description	Register for notifications of new relationships to the given resource. `ResourceRelationshipReceiver.newResourceRelationships()` is invoked when a new relationship 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	registerForChangedResourceRelationships
Description	Registers for notification of updated relationships. `ResourceRelationshipReceiver.changedResourceRelationships()` is invoked when a relationship is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResourceRelationshipsByGenusType
Description	Register for notifications of changed relationshipsof the given genus type. `ResourceRelationshipReceiver.changedResourceRelationships()` is invoked when a relationship is changed.
Parameters	`osid.type.Type`	`resourceRelationshipGenusType`	the rsource relationship genus type
Errors	NULL_ARGUMENT		`resourceRelationshipGenusType is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResourceRelationshipsForSourceResource
Description	Register for notifications of changed relationships from the given resource. `ResourceRelationshipReceiver.changedResourceRelationships()` is invoked when a relationship 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	registerForChangedResourceRelationshipsForDestinationResource
Description	Register for notifications of changed relationships to the given resource. `ResourceRelationshipReceiver.changedResourceRelationships()` is invoked when a relationship 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	registerForChangedResourceRelationship
Description	Registers for notification of an updated relationship. `ResourceRelationshipReceiver.changedResourceRelationships()` is invoked when the specified relationship is changed.
Parameters	`osid.id.Id`	`resourceRelationshipId`	the `Id` of the `ResourceRelationship` to monitor
Errors	NULL_ARGUMENT		`resourceRelationshipId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResourceRelationships
Description	Registers for notification of deleted relationships. `ResourceRelationshipReceiver.deletedResourceRelationships()` is invoked when a relationship is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResourceRelationshipsByGenusType
Description	Register for notifications of deleted relationships of the given genus type. `ResourceRelationshipReceiver.deletedResourceRelationships()` is invoked when a relationship is deleted.
Parameters	`osid.type.Type`	`resourceRelationshipGenusType`	the rsource relationship genus type
Errors	NULL_ARGUMENT		`resourceRelationshipGenusType is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResourceRelationshipsForSourceResource
Description	Register for notifications of deleted relationships from the given resource. `ResourceRelationshipReceiver.deletedResourceRelationships()` is invoked when a relationship is deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceRelationshipId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResourceRelationshipsForDestinationResource
Description	Register for notifications of deleted relationships to the given resource. `ResourceRelationshipReceiver.deletedResourceRelationships()` is invoked when a relationship is deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceRelationshipId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResourceRelationship
Description	Registers for notification of a deleted relationship. `ResourceRelationshipReceiver.changedResourceRelationships()` is invoked when the specified relationship is deleted.
Parameters	`osid.id.Id`	`resourceRelationshipId`	the `Id` of the `ResourceRelationship` to monitor
Errors	NULL_ARGUMENT		`resourceRelationshipId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.