OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.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.
MethodreliableBusinessNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableBusinessNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeBusinessNotification
Description

Acknowledge a business notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
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.
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.
MethodregisterForChangedBusinessHierarchy
Description

Registers for notification of an updated business hierarchy structure. BusinessReceiver.changedChildOfBusinesses() is invoked when a node experiences a change in its children.

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

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

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

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

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