OSID - osid.personnel.PositionNotificationSession Service Interface Definition

Interface	osid.personnel.PositionNotificationSession
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 `Position` 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	canRegisterForPositionNotifications
Description	Tests if this user can register for `Position` 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 positions 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	reliablePositionNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePositionNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePositionNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePositionNotification
Description	Acknowledge a position 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	registerForNewPositions
Description	Register for notifications of new positions. `PositionReceiver.newPositions()` is invoked when a new `Position` is appears in this realm.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPositionsForOrganization
Description	Register for notifications of new positions for an organization. `PositionReceiver.newPositions()` is invoked when a new `Position` appears in this realm.
Parameters	`osid.id.Id`	`organizationId`	an organization 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	registerForChangedPositions
Description	Registers for notification of updated positions. `PositionReceiver.changedPositions()` is invoked when a position 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	registerForChangedPositionsForOrganization
Description	Register for notifications of changed positions for the given organization. `PositionReceiver.changedPositions()` is invoked when a `Position` for the organization in this realm is changed.
Parameters	`osid.id.Id`	`organizationId`	an organization 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	registerForChangedPosition
Description	Registers for notification of an updated position. `PositionReceiver.changedPositions()` is invoked when the specified position in this realm is changed.
Parameters	`osid.id.Id`	`positionId`	the `Id` of the `Position` to monitor
Errors	NOT_FOUND		a position was not found identified by the given `Id`
	NULL_ARGUMENT		`positionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPositions
Description	Registers for notification of deleted positions. `PositionReceiver.deletedPositions()` is invoked when a position 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	registerForDeletedPositionsForOrganization
Description	Register for notifications of deleted positions for the given organization. `PositionReceiver.deletedPositions()` is invoked when a `Position` for the organization is removed from this realm.
Parameters	`osid.id.Id`	`organizationId`	an organization 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	registerForDeletedPosition
Description	Registers for notification of a deleted position. `PositionReceiver.deletedPositions()` is invoked when the specified position is removed from this realm.
Parameters	`osid.id.Id`	`positionId`	the `Id` of the `Position` to monitor
Errors	NOT_FOUND		a position was not found identified by the given `Id`
	NULL_ARGUMENT		`positionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.