OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.BusinessNotificationSession
Implementsosid.OsidSession
Description

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

MethodcanRegisterForBusinessNotifications
Description

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.

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

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

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

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.

Parametersosid.id.IdbusinessIdthe Id of the business to monitor
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewBusinessDescendants
Description

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.

Parametersosid.id.IdbusinessIdthe Id of the business to monitor
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBusinesses
Description

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

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

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

Parametersosid.id.IdbusinessIdthe Id of the Business to monitor
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBusinesses
Description

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

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

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

Parametersosid.id.IdbusinessIdthe Id of the Business to monitor
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBusinessAncestors
Description

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.

Parametersosid.id.IdbusinessIdthe Id of the business to monitor
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBusinessDescendants
Description

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.

Parametersosid.id.IdbusinessIdthe Id of the business to monitor
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.