OSID - osid.relationship.rules.RelationshipEnablerNotificationSession Service Interface Definition

Interface	osid.relationship.rules.RelationshipEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.relationship.rules.RelationshipRulesManager`
Used By	`osid.relationship.rules.RelationshipRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `RelationshipEnabler` objects in this `Relationship`. This also includes existing `RelationshipEnablers` that may appear or disappear due to changes in the `Relationship` 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 `RelationshipEnablerLookupSession`.
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	canRegisterForRelationshipEnablerNotifications
Description	Tests if this user can register for `RelationshipEnabler` 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 relationship enablers 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 lookups to this family only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableRelationshipEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRelationshipEnablerNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRelationshipEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRelationshipEnablerNotification
Description	Acknowledge a relationship enabler 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	registerForNewRelationshipEnablers
Description	Register for notifications of new relationship enablers. `RelationshipEnablerReceiver.newRelationshipEnablers()` is invoked when a new `RelationshipEnabler` appears in this family.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelationshipEnablers
Description	Registers for notification of updated relationship enabelrs. `RelationshipEnablerReceiver.changedRelationshipEnablers()` is invoked when a relationship enabler 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	registerForChangedRelationshipEnabler
Description	Registers for notification of an updated relationship enabler. `ProvisionableReceiver.changedRelationshipEnablers()` is invoked when the specified relationship enabler in this family is changed.
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler` to monitor
Errors	NULL_ARGUMENT		`relationshipEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelationshipEnablers
Description	Registers for notification of deleted relationship enablers. `RelationshipEnablerReceiver.deletedRelationshipEnablers()` is invoked when a relationship enabler 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	registerForDeletedRelationshipEnabler
Description	Registers for notification of a deleted relationship enabler. `RelationshipEnablerReceiver.deletedRelationshipEnablers()` is invoked when the specified relationship enabler is deleted or removed from this family.
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler` to monitor
Errors	NULL_ARGUMENT		`relationshipEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.