OSID - osid.financials.posting.PostEntryNotificationSession Service Interface Definition

Interface	osid.financials.posting.PostEntryNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.financials.posting.FinancialsPostingManager`
Used By	`osid.financials.posting.FinancialsPostingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `PostEntries` . in this `Business` . This also includes existing post entries that may appear or disappear due to changes in the `Business` 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 `PostEntryLookupSession` .
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.financials.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForPostEntryNotifications
Description	Tests if this user can register for `PostEntry` 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	useFederatedBusinessView
Description	Federates the view for methods in this session. A federated view will include post entries in catalogs which are children of this catalog in the business hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBusinessView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this business only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliablePostEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePostEntryNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePostEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePostEntryNotification
Description	Acknowledge a post entry 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	registerForNewPostEntries
Description	Register for notifications of new post entries. `PostEntryReceiver.newPostEntries()` is invoked when a new `PostEntry` appears in this business.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPostEntriesForPost
Description	Register for notifications of new post entries for the given post. `PostEntryReceiver.newPostEntries()` is invoked when a new `PostEntry` appears in this business.
Parameters	`osid.id.Id`	`postId`	the `Id` of the `Post` to monitor
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPostEntriesForAccount
Description	Register for notifications of new post entries for the given account. `PostEntryReceiver.newPostEntries()` is invoked when a new `PostEntry` appears in this business.
Parameters	`osid.id.Id`	`accountId`	the `Id` of the `Account` to monitor
Errors	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPostEntriesForActivity
Description	Register for notifications of new post entries for the given activity. `PostEntryReceiver.newPostEntries()` is invoked when a new `PostEntry` appears in this business.
Parameters	`osid.id.Id`	`activityId`	the `Id` of the `Activity` to monitor
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPostEntries
Description	Registers for notification of updated payers. `PostEntryReceiver.changedPostEntries()` is invoked when a post entry in this business is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPostEntriesForPost
Description	Registers for notification of updated post entries for the given post. `PostEntryReceiver.changedPostEntries()` is invoked when the specified post entry in this business is changed.
Parameters	`osid.id.Id`	`postId`	the `Id` of the `Post` to monitor
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPostEntriesForAccount
Description	Register for notifications of updated post entries for the given account. `PostEntryReceiver.changedPostEntries()` is invoked when a `PostEntry` is changed in this business.
Parameters	`osid.id.Id`	`accountId`	the `Id` of the `Account` to monitor
Errors	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPostEntriesForActivity
Description	Register for notifications of updated post entries for the given activity. `PostEntryReceiver.changedPostEntries()` is invoked when a `PostEntry` is changed in this business.
Parameters	`osid.id.Id`	`activityId`	the `Id` of the `Activity` to monitor
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPostEntry
Description	Registers for notification of an updated post entries. `PostEntryReceiver.changedPostEntries()` is invoked when the specified post entry in this business is changed.
Parameters	`osid.id.Id`	`postEntryId`	the `Id` of the `PostEntry` to monitor
Errors	NULL_ARGUMENT		`postEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPostEntries
Description	Registers for notification of deleted post entries. `PostEntryReceiver.deletedPostEntries()` is invoked when a post entry is deleted or removed from this business.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPostEntriesForPost
Description	Registers for notification of deleted post entries for the given post. `PostEntryReceiver.deletedPostEntries()` is invoked when the specified post entry is deleted or removed from this business.
Parameters	`osid.id.Id`	`postId`	the `Id` of the `Post` to monitor
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPostEntriesForAccount
Description	Register for notifications of deleted post entries for the given account. `PostEntryReceiver.deletedPostEntries()` is invoked when a `PostEntry` is removed or deleted from this business.
Parameters	`osid.id.Id`	`accountId`	the `Id` of the `Account` to monitor
Errors	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPostEntriesForActivity
Description	Register for notifications of deleted post entries for the given activity. `PostEntryReceiver.deletedPostEntry()` is invoked when a `PostEntry` is removed or deleted from this business.
Parameters	`osid.id.Id`	`activityId`	the `Id` of the `Activity` to monitor
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPostEntry
Description	Registers for notification of a deleted post entries. `PostEntryReceiver.deletedPostEntries()` is invoked when the specified post entry is deleted or removed from this business.
Parameters	`osid.id.Id`	`postEntryId`	the `Id` of the `PostEntry` to monitor
Errors	NULL_ARGUMENT		`postEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.