OSID - osid.relationship.RelationshipNotificationSession Service Interface Definition

Interface	osid.relationship.RelationshipNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.relationship.RelationshipManager`
Used By	`osid.relationship.RelationshipProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Relationship` objects in this `Family`. This also includes existing relationships that may appear or disappear due to changes in the `Family` hierarchy, 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 two views defined in this session correspond to the views in the `RelationshipLookupSession`.
Method	getFamilyId
Description	Gets the `Family` `Id` associated with this session.
Return	`osid.id.Id`		the `Family Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFamily
Description	Gets the `Family` associated with this session.
Return	`osid.relationship.Family`		the family
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForRelationshipNotifications
Description	Tests if this user can register for `Relationship` 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	useFederatedFamilyView
Description	Federates the view for methods in this session. A federated view will include relationships in families which are children of this family in the family hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFamilyView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this family only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableRelationshipNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRelationshipNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRelationshipNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRelationshipNotification
Description	Acknowledge a 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	registerForNewRelationships
Description	Register for notifications of new relationships. `RelationshipReceiver.newRelationships()` is invoked when a new `Relationship` appears in this family.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRelationshipsForSource
Description	Register for notifications of new relationships from the given source. `RelationshipReceiver.newRelationships()` is invoked when a new `Relationship` appears for the given peer.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source to monitor
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRelationshipsForDestination
Description	Register for notifications of new relationships to the given destination. `RelationshipReceiver.newRelationships()` is invoked when a new `Relationship` appears for the given peer.
Parameters	`osid.id.Id`	`destinationId`	the `Id` of the destination node to monitor
Errors	NULL_ARGUMENT		`destinationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRelationshipsByGenusType
Description	Register for notifications of new relationships. `RelationshipReceiver.newRelationships()` is invoked when a new `Relationship` appears for the given peer.
Parameters	`osid.type.Type`	`relationshipGenusType`	the genus type of the `Relationship` to monitor
Errors	NULL_ARGUMENT		`relationshipGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelationships
Description	Registers for notification of updated relationships. `RelationshipReceiver.changedRelationships()` is invoked when a relationship in this family is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelationshipsForSource
Description	Register for notifications of updated relationships from the given source node. `RelationshipReceiver.changedRelationships()` is invoked when a `Relationship` if changed for the given peer.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source node to monitor
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelationshipsForDestination
Description	Register for notifications of updated relationships to the given destination node. `RelationshipReceiver.changedRelationships()` is invoked when a `Relationship` if changed for the given peer.
Parameters	`osid.id.Id`	`destinationId`	the `Id` of the destination node to monitor
Errors	NULL_ARGUMENT		`destinationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelationshipsByGenusType
Description	Register for notifications of updated relationships. `RelationshipReceiver.changedRelationships()` is invoked when a `Relationship` if changed for the given peer.
Parameters	`osid.type.Type`	`relationshipGenusType`	the genus type of the `Relationship` to monitor
Errors	NULL_ARGUMENT		`relationshipGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelationship
Description	Registers for notification of an updated relationship. `RelationshipReceiver.changedRelationships()` is invoked when the specified relationship in this family is changed.
Parameters	`osid.id.Id`	`relationshipId`	the `Id` of the `Relationship` to monitor
Errors	NULL_ARGUMENT		`relationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelationships
Description	Registers for notification of deleted relationships. `RelationshipReceiver.deletedRelationships()` is invoked when a relationship is deleted or removed from this family.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelationshipsForSource
Description	Register for notifications of deleted relationships from the given source node. `RelationshipReceiver.deletedRelationships()` is invoked when a `Relationship` if removed for the given peer.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source node to monitor
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelationshipsForDestination
Description	Register for notifications of deleted relationships to the given destination node. `RelationshipReceiver.deletedRelationships()` is invoked when a `Relationship` if removed for the given peer.
Parameters	`osid.id.Id`	`destinationId`	the `Id` of the destination node to monitor
Errors	NULL_ARGUMENT		`destinationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelationshipsByGenusType
Description	Register for notifications of deleted relationships. `RelationshipReceiver.deletedRelationships()` is invoked when a `Relationship` if removed for the given peer.
Parameters	`osid.type.Type`	`relationshipGenusType`	the genus type of the `Relationship` to monitor
Errors	NULL_ARGUMENT		`relationshipGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelationship
Description	Registers for notification of a deleted relationship. `RelationshipReceiver.deletedRelationships()` is invoked when the specified relationship is deleted or removed from this family.
Parameters	`osid.id.Id`	`relationshipId`	the `Id` of the `Relationship` to monitor
Errors	NULL_ARGUMENT		`relationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.