org.osid.financials

Interface BusinessNotificationSession

All Superinterfaces:

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

public interface BusinessNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForBusinessNotifications() Tests if this user can register for Business notifications.
void	registerForChangedBusiness(Id businessId) Registers for notification of an updated business.
void	registerForChangedBusinesses() Registers for notification of updated businesses.
void	registerForDeletedBusiness(Id businessId) Registers for notification of a deleted business.
void	registerForDeletedBusinessAncestors(Id businessId) Registers for notification if an ancestor is removed from the specified business in the business hierarchy.
void	registerForDeletedBusinessDescendants(Id businessId) Registers for notification if a descendant is removed from fthe specified business in the business hierarchy.
void	registerForDeletedBusinesses() Registers for notification of deleted businesses.
void	registerForNewBusinessAncestors(Id businessId) Registers for notification if an ancestor is added to the specified business in the business hierarchy.
void	registerForNewBusinessDescendants(Id businessId) Registers for notification if a descendant is added to the specified business in the business hierarchy.
void	registerForNewBusinesses() Register for notifications of new businesses.

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

canRegisterForBusinessNotifications

boolean canRegisterForBusinessNotifications()

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

registerForNewBusinesses

void registerForNewBusinesses()
                              throws OperationFailedException,
                                     PermissionDeniedException

Register for notifications of new businesses. BusinessReceiver.newBusinesses() is invoked when a new Business is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBusinessAncestors

void registerForNewBusinessAncestors(Id businessId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification if an ancestor is added to the specified business in the business hierarchy. BusinessReceiver.newBusinessAncestor() is invoked when the specified business experiences an addition in ancestry.

Parameters:

businessId - the Id of the business to monitor

Throws:

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBusinessDescendants

void registerForNewBusinessDescendants(Id businessId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Registers for notification if a descendant is added to the specified business in the business hierarchy. BusinessReceiver.newBusinessDescendant() is invoked when the specified business experiences an addition in descendants.

Parameters:

businessId - the Id of the business to monitor

Throws:

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBusinesses

void registerForChangedBusinesses()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of updated businesses. BusinessReceiver.changedBusinesses() is invoked when a business is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBusiness

void registerForChangedBusiness(Id businessId)
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of an updated business. BusinessReceiver.changedBusinesses() is invoked when the specified business is changed.

Parameters:

businessId - the Id of the Business to monitor

Throws:

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBusinesses

void registerForDeletedBusinesses()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of deleted businesses. BusinessReceiver.deletedBusinesses() is invoked when a business is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBusiness

void registerForDeletedBusiness(Id businessId)
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of a deleted business. BusinessReceiver.deletedBusinesses() is invoked when the specified business is deleted.

Parameters:

businessId - the Id of the Business to monitor

Throws:

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBusinessAncestors

void registerForDeletedBusinessAncestors(Id businessId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Registers for notification if an ancestor is removed from the specified business in the business hierarchy. BusinessReceiver.deletedBusinessAncestor() is invoked when the specified business experiences a removal of an ancestor.

Parameters:

businessId - the Id of the business to monitor

Throws:

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBusinessDescendants

void registerForDeletedBusinessDescendants(Id businessId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Registers for notification if a descendant is removed from fthe specified business in the business hierarchy. BusinessReceiver.deletedBusinessDescednant() is invoked when the specified business experiences a removal of one of its descdendents.

Parameters:

businessId - the Id of the business to monitor

Throws:

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.