OSID - osid.personnel.OrganizationNotificationSession Service Interface Definition

Interface	osid.personnel.OrganizationNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Organization` 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.
Method	getRealmId
Description	Gets the `Realm` `Id` associated with this session.
Return	`osid.id.Id`		the `Realm Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRealm
Description	Gets the `Realm` associated with this session.
Return	`osid.personnel.Realm`		the realm
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForOrganizationNotifications
Description	Tests if this user can register for `Organization` 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	useFederatedRealmView
Description	Federates the view for methods in this session. A federated view will include notifications for organizations in realms which are children of this realm in the realm hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedRealmView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this realm only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableOrganizationNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeOrganizationNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableOrganizationNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeOrganizationNotification
Description	Acknowledge an organization 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	registerForNewOrganizations
Description	Register for notifications of new organizations. `OrganizationReceiver.newOrganizations()` is invoked when a new `Organization` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOrganizations
Description	Registers for notification of updated organizations. `OrganizationReceiver.changedOrganizations()` is invoked when an organization in this realm is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOrganization
Description	Registers for notification of an updated organization. `OrganizationReceiver.changedOrganizations()` is invoked when the specified organization in this realm is changed.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of the `Organization` to monitor
Errors	NOT_FOUND		an organization was not found identified by the given `Id`
	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOrganizations
Description	Registers for notification of deleted organizations. `OrganizationReceiver.deletedOrganizations()` is invoked when an organization is removed from this realm.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOrganization
Description	Registers for notification of a deleted organization. `OrganizationReceiver.deletedOrganizations()` is invoked when the specified organization is removed from this realm.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of the `Organization` to monitor
Errors	NOT_FOUND		an organization was not found identified by the given `Id`
	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOrganizationHierarchy
Description	Registers for notification of an updated organization hierarchy structure. `OrganizationReceiver.changedChildOfOrganizations()` is invoked when the specified node or any of its ancestors 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	registerForChangedOrganizationHierarchyForAncestors
Description	Registers for notification of an updated organization hierarchy structure. `OrganizationReceiver.changedChildOfOrganizations()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of the `Organization` node to monitor
Errors	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOrganizationHierarchyForDescendants
Description	Registers for notification of an updated organization hierarchy structure. `OrganizationReceiver.changedChildOfOrganizations()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of the `Organization` node to monitor
Errors	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.