OSID - osid.relationship.FamilyNotificationSession Service Interface Definition

Interface	osid.relationship.FamilyNotificationSession
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 `Family` objects. 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. Notifications are triggered with changes to the `Family` object itself. Adding and removing relationships result in notifications available from the notification session for rules.
Method	canRegisterForFamilyNotifications
Description	Tests if this user can register for `Family` 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	reliableFamilyNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeFamilyNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableFamilyNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeFamilyNotification
Description	Acknowledge a family 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	registerForNewFamilies
Description	Register for notifications of new families. `FamilyReceiver.newFamilies()` is invoked when a new `Family` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFamilies
Description	Registers for notification of updated families. `FamilyReceiver.changedFamilies()` is invoked when a family is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFamily
Description	Registers for notification of an updated family. `FamilyReceiver.changedFamilies()` is invoked when the specified family is changed.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family` to monitor
Errors	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFamilies
Description	Registers for notification of deleted families. `FamilyReceiver.deletedFamilies()` is invoked when a family is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFamily
Description	Registers for notification of a deleted family. `FamilyReceiver.deletedFamilies()` is invoked when the specified family is deleted.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family` to monitor
Errors	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFamilyHierarchy
Description	Registers for notification of an updated family hierarchy structure. `FamilyReceiver.changedChildOfFamilies()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFamilyHierarchyForAncestors
Description	Registers for notification of an updated family hierarchy structure. `FamilyReceiver.changedChildOfFamilies()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family` node to monitor
Errors	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFamilyHierarchyForDescendants
Description	Registers for notification of an updated family hierarchy structure. `FamilyReceiver.changedChildOfFamilies()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family` node to monitor
Errors	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.