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
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForBusinessNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void registerForNewBusinesses() throws OperationFailedException, PermissionDeniedException
BusinessReceiver.newBusinesses()
is invoked when a new
Business
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBusinessAncestors(Id businessId) throws OperationFailedException, PermissionDeniedException
BusinessReceiver.newBusinessAncestor()
is invoked when the
specified business experiences an addition in ancestry.businessId
- the Id
of the business to monitorNullArgumentException
- businessId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBusinessDescendants(Id businessId) throws OperationFailedException, PermissionDeniedException
BusinessReceiver.newBusinessDescendant()
is invoked when the
specified business experiences an addition in descendants.businessId
- the Id
of the business to monitorNullArgumentException
- businessId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBusinesses() throws OperationFailedException, PermissionDeniedException
BusinessReceiver.changedBusinesses()
is invoked when a
business is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBusiness(Id businessId) throws OperationFailedException, PermissionDeniedException
BusinessReceiver.changedBusinesses()
is invoked when the
specified business is changed.businessId
- the Id of the Business
to monitorNullArgumentException
- businessId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBusinesses() throws OperationFailedException, PermissionDeniedException
BusinessReceiver.deletedBusinesses()
is invoked when a
business is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBusiness(Id businessId) throws OperationFailedException, PermissionDeniedException
BusinessReceiver.deletedBusinesses()
is invoked when the
specified business is deleted.businessId
- the Id of the Business
to monitorNullArgumentException
- businessId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBusinessAncestors(Id businessId) throws OperationFailedException, PermissionDeniedException
BusinessReceiver.deletedBusinessAncestor()
is invoked when the
specified business experiences a removal of an ancestor.businessId
- the Id
of the business to monitorNullArgumentException
- businessId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBusinessDescendants(Id businessId) throws OperationFailedException, PermissionDeniedException
BusinessReceiver.deletedBusinessDescednant()
is invoked when
the specified business experiences a removal of one of its
descdendents.businessId
- the Id
of the business to monitorNullArgumentException
- businessId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.