OSID - osid.billing.EntryNotificationSession Service Interface Definition

Interface	osid.billing.EntryNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Entry` objects in this `Business.` This also includes existing 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 `EntryLookupSession.`
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.billing.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForEntryNotifications
Description	Tests if this user can register for `Entry` 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 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	reliableEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeEntryNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeEntryNotification
Description	Acknowledge an 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	registerForNewEntries
Description	Register for notifications of new entries. `EntryReceiver.newEntries()` is invoked when a new `Entry` appears in this business.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEntriesForCustomer
Description	Register for notifications of new entries for the given customer. `EntryReceiver.newEntries()` is invoked when a new `Entry` appears in this business.
Parameters	`osid.id.Id`	`customerId`	the `Id` of the `Customer` to monitor
Errors	NULL_ARGUMENT		`customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEntriesForItem
Description	Register for notifications of new entries for the given item. `EntryReceiver.newEntries()` is invoked when a new `Entry` appears in this business.
Parameters	`osid.id.Id`	`itemId`	the `Id` of the `Item` to monitor
Errors	NULL_ARGUMENT		`itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEntries
Description	Registers for notification of updated customers. `EntryReceiver.changedEntries()` is invoked when an 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	registerForChangedEntriesForCustomer
Description	Registers for notification of updated entries for the given customer. `EntryReceiver.changedEntries()` is invoked when the specified entry in this business is changed.
Parameters	`osid.id.Id`	`customerId`	the `Id` of the `Customer` to monitor
Errors	NULL_ARGUMENT		`customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEntriesForItem
Description	Registers for notification of updated entries for the given item. `EntryReceiver.changedEntries()` is invoked when the specified entry in this business is changed.
Parameters	`osid.id.Id`	`itemId`	the `Id` of the `Item` to monitor
Errors	NULL_ARGUMENT		`itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEntry
Description	Registers for notification of an updated entry. `EntryReceiver.changedEntry()` is invoked when the specified entry in this business is changed.
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry` to monitor
Errors	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEntries
Description	Registers for notification of deleted entries. `EntryReceiver.deletedEntries()` is invoked when an 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	registerForDeletedEntriesForCustomer
Description	Registers for notification of deleted entries for the given customer. `EntryReceiver.deletedEntries()` is invoked when the specified entry is deleted or removed from this business.
Parameters	`osid.id.Id`	`customerId`	the `Id` of the `Customer` to monitor
Errors	NULL_ARGUMENT		`customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEntriesForItem
Description	Registers for notification of deleted entries for the given item. `EntryReceiver.deletedEntries()` is invoked when the specified entry is deleted or removed from this business.
Parameters	`osid.id.Id`	`itemId`	the `Id` of the `Item` to monitor
Errors	NULL_ARGUMENT		`itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEntry
Description	Registers for notification of a deleted entry. `EntryReceiver.deletedEntries()` is invoked when the specified entry is deleted or removed from this business.
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry` to monitor
Errors	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.