OSID - osid.acknowledgement.CreditNotificationSession Service Interface Definition

Interface	osid.acknowledgement.CreditNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.acknowledgement.AcknowledgementManager`
Used By	`osid.acknowledgement.AcknowledgementProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Credit` 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	getBillingId
Description	Gets the `Billing` `Id` associated with this session.
Return	`osid.id.Id`		the `Billing Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBilling
Description	Gets the `Billing` associated with this session.
Return	`osid.acknowledgement.Billing`		the billing
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForCreditNotifications
Description	Tests if this user can register for `Credit` 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	useFederatedBillingView
Description	Federates the view for methods in this session. A federated view will include notifications for credits in billings which are children of this billing in the billing hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBillingView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this billing only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableCreditNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCreditNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCreditNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCreditNotification
Description	Acknowledge a credit 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	registerForNewCredits
Description	Register for notifications of new credits. `CreditReceiver.newCredits()` is invoked when a new `Credit` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCreditsByGenusType
Description	Register for notifications of new credits by the given credit genus `Type`. `CreditReceiver.newCredits()` is invoked when a new `Credit` appears in this billing.
Parameters	`osid.type.Type`	`creditGenusType`	the `Id` of the reference to monitor
Errors	NULL_ARGUMENT		`creditGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCreditsForReference
Description	Register for notifications of new credits for the given reference `Id`. `CreditReceiver.newCredits()` is invoked when a new `Credit` appears in this billing.
Parameters	`osid.id.Id`	`referenceId`	the reference to monitor
Errors	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCreditsForResource
Description	Register for notifications of new credits for the given resource `Id`. `CreditReceiver.newCredits()` is invoked when a new `Credit` appears in this billing.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCredits
Description	Registers for notification of updated credits. `CreditReceiver.changedCredits()` is invoked when a credit in this billing is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCreditsByGenusType
Description	Register for notifications of changed credits by the given credit gfenus `Type`. `CreditReceiver.changedCredits()` is invoked when a `Credit` for the reference in this billing is changed.
Parameters	`osid.type.Type`	`creditGenusType`	the genus type of the credit to monitor
Errors	NULL_ARGUMENT		`creditGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCreditsForReference
Description	Register for notifications of changed credits for the given reference `Id`. `CreditReceiver.changedCredits()` is invoked when a `Credit` for the reference in this billing is changed.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference to monitor
Errors	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCreditsForResource
Description	Register for notifications of changed credits for the given resource `Id`. `CreditReceiver.changedCredits()` is invoked when a `Credit` for the resource is changed in this billing.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCredit
Description	Registers for notification of an updated credit. `CreditReceiver.changedCredits()` is invoked when the specified credit in this billing is changed.
Parameters	`osid.id.Id`	`creditId`	the `Id` of the `Credit` to monitor
Errors	NOT_FOUND		a credit was not found identified by the given `Id`
	NULL_ARGUMENT		`creditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCredits
Description	Registers for notification of deleted credits. `CreditReceiver.deletedCredit()` is invoked when a credit is removed from this billing.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCreditsByGenusType
Description	Register for notifications of deleted credits by the credit genus `Type`. `CreditReceiver.deletedCredit()` is invoked when a `Credit` for the reference is removed from this billing.
Parameters	`osid.type.Type`	`creditGenusType`	the genus type of the credit to monitor
Errors	NULL_ARGUMENT		`creditGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCreditsForReference
Description	Register for notifications of deleted credits for the given reference `Id`. `CreditReceiver.deletedCredit()` is invoked when a `Credit` for the reference is removed from this billing.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference to monitor
Errors	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCreditsForResource
Description	Register for notifications of deleted credits for the given resource `Id`. `CreditReceiver.deletedCredit()` is invoked when a `Credit` for the resource is removed from this billing.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCredit
Description	Registers for notification of a deleted credit. `CreditReceiver.deletedCredit()` is invoked when the specified credit is removed from this billing.
Parameters	`osid.id.Id`	`creditId`	the `Id` of the `Credit` to monitor
Errors	NOT_FOUND		a credit was not found identified by the given `Id`
	NULL_ARGUMENT		`creditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.