OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.BillingNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Billing 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.

Notifications are triggered with changes to the Billing object itself. Adding and removing credits result in notifications available from the notification session for credits.

MethodcanRegisterForBillingNotifications
Description

Tests if this user can register for Billing 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableBillingNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeBillingNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableBillingNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeBillingNotification
Description

Acknowledge a billing notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewBillings
Description

Register for notifications of new billings. BillingReceiver.newBillings() is invoked when a new Billing is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBillings
Description

Registers for notification of updated billings. BillingReceiver.changedBillings() is invoked when a billing is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBilling
Description

Registers for notification of an updated billing. BillingReceiver.changedBillings() is invoked when the specified billing is changed.

Parametersosid.id.IdbillingIdthe Id of the Billing to monitor
ErrorsNULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBillings
Description

Registers for notification of deleted billings. BillingReceiver.deletedBillings() is invoked when a billing is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBilling
Description

Registers for notification of a deleted billing. BillingReceiver.deletedBillings() is invoked when the specified billing is deleted.

Parametersosid.id.IdbillingIdthe Id of the Billing to monitor
ErrorsNULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBillingHierarchy
Description

Registers for notification of an updated billing hierarchy structure. BillingReceiver.changedChildOfBillings() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBillingHierarchyForAncestors
Description

Registers for notification of an updated billing hierarchy structure. BillingReceiver.changedChildOfBillings() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdbillingIdthe Id of the Billing node to monitor
ErrorsNULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBillingHierarchyForDescendants
Description

Registers for notification of an updated billing hierarchy structure. BillingReceiver.changedChildOfBillings() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdbillingIdthe Id of the Billing node to monitor
ErrorsNULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.