org.osid.acknowledgement

Interface BillingNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BillingNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForBillingNotifications() Tests if this user can register for Billing notifications.
void	registerForChangedBilling(Id billingId) Registers for notification of an updated billing.
void	registerForChangedBillings() Registers for notification of updated billings.
void	registerForDeletedBilling(Id billingId) Registers for notification of a deleted billing.
void	registerForDeletedBillingAncestors(Id billingId) Registers for notification of an updated hierarchy structure that removes an ancestor of the specified billing BillingReceiver.deletedAncestor() is invoked when the specified billing node loses an ancestor.
void	registerForDeletedBillingDescendants(Id billingId) Registers for notification of an updated hierarchy structure that removes a descendant of the specified billing.
void	registerForDeletedBillings() Registers for notification of deleted billings.
void	registerForNewBillingAncestors(Id billingId) Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified billing.
void	registerForNewBillingDescendants(Id billingId) Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified billing.
void	registerForNewBillings() Register for notifications of new billings.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canRegisterForBillingNotifications

boolean canRegisterForBillingNotifications()

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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

registerForNewBillings

void registerForNewBillings()
                            throws OperationFailedException,
                                   PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBillingAncestors

void registerForNewBillingAncestors(Id billingId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified billing. BillingReceiver.newAncestorBilling() is invoked when the specified billing node gets a new ancestor.

Parameters:

billingId - the Id of the Billing node to monitor

Throws:

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBillingDescendants

void registerForNewBillingDescendants(Id billingId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified billing. BillingReceiver.newDescendantBilling() is invoked when the specified billing node gets a new descendant.

Parameters:

billingId - the Id of the Billing node to monitor

Throws:

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBillings

void registerForChangedBillings()
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBilling

void registerForChangedBilling(Id billingId)
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

billingId - the Id of the Billing to monitor

Throws:

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBillings

void registerForDeletedBillings()
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBilling

void registerForDeletedBilling(Id billingId)
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

billingId - the Id of the Billing to monitor

Throws:

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBillingAncestors

void registerForDeletedBillingAncestors(Id billingId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified billing BillingReceiver.deletedAncestor() is invoked when the specified billing node loses an ancestor.

Parameters:

billingId - the Id of the Billing to monitor

Throws:

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBillingDescendants

void registerForDeletedBillingDescendants(Id billingId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes a descendant of the specified billing. BillingReceiver.deletedDescendant() is invoked when the specified billing node loses a descendant.

Parameters:

billingId - the Id of the Billing to monitor

Throws:

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.