OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.EntryNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Entry objects in this Business. This also includes existing entries that may appear or disappear due to changes in the Business hierarchy, 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.

The two views defined in this session correspond to the views in the EntryLookupSession.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.billing.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForEntryNotifications
Description

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

Federates the view for methods in this session. A federated view will include entries in catalogs which are children of this catalog in the business hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBusinessView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this business only.

CompliancemandatoryThis method is must be implemented.
MethodreliableEntryNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableEntryNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeEntryNotification
Description

Acknowledge an entry notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewEntries
Description

Register for notifications of new entries. EntryReceiver.newEntries() is invoked when a new Entry appears in this business.

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

Register for notifications of new entries for the given customer. EntryReceiver.newEntries() is invoked when a new Entry appears in this business.

Parametersosid.id.IdcustomerIdthe Id of the Customer to monitor
ErrorsNULL_ARGUMENT customerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewEntriesForItem
Description

Register for notifications of new entries for the given item. EntryReceiver.newEntries() is invoked when a new Entry appears in this business.

Parametersosid.id.IditemIdthe Id of the Item to monitor
ErrorsNULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEntries
Description

Registers for notification of updated customers. EntryReceiver.changedEntries() is invoked when an entry in this business is changed.

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

Registers for notification of updated entries for the given customer. EntryReceiver.changedEntries() is invoked when the specified entry in this business is changed.

Parametersosid.id.IdcustomerIdthe Id of the Customer to monitor
ErrorsNULL_ARGUMENT customerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEntriesForItem
Description

Registers for notification of updated entries for the given item. EntryReceiver.changedEntries() is invoked when the specified entry in this business is changed.

Parametersosid.id.IditemIdthe Id of the Item to monitor
ErrorsNULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEntry
Description

Registers for notification of an updated entry. EntryReceiver.changedEntry() is invoked when the specified entry in this business is changed.

Parametersosid.id.IdentryIdthe Id of the Entry to monitor
ErrorsNULL_ARGUMENT entryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEntries
Description

Registers for notification of deleted entries. EntryReceiver.deletedEntries() is invoked when an entry is deleted or removed from this business.

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

Registers for notification of deleted entries for the given customer. EntryReceiver.deletedEntries() is invoked when the specified entry is deleted or removed from this business.

Parametersosid.id.IdcustomerIdthe Id of the Customer to monitor
ErrorsNULL_ARGUMENT customerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEntriesForItem
Description

Registers for notification of deleted entries for the given item. EntryReceiver.deletedEntries() is invoked when the specified entry is deleted or removed from this business.

Parametersosid.id.IditemIdthe Id of the Item to monitor
ErrorsNULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEntry
Description

Registers for notification of a deleted entry. EntryReceiver.deletedEntries() is invoked when the specified entry is deleted or removed from this business.

Parametersosid.id.IdentryIdthe Id of the Entry to monitor
ErrorsNULL_ARGUMENT entryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.