OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.BankNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Bank 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 session is closed.

MethodcanRegisterForBankNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableBankNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeBankNotification
Description

Acknowledge a bank notification.

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

Register for notifications of new banks. BankReceiver.newBanks() is invoked when a new Bank is created.

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

Registers for notification of updated banks. BankReceiver.changedBanks() is invoked when a bank is changed.

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

Registers for notification of an updated bank. BankReceiver.changedBanks() is invoked when the specified bank is changed.

Parametersosid.id.IdbankIdthe Id of the bank to monitor
ErrorsNULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBanks
Description

Registers for notification of deleted banks. BankReceiver.deletedBanks() is invoked when a bank is deleted.

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

Registers for notification of a deleted bank. BankReceiver.deletedBanks() is invoked when the specified bank is deleted.

Parametersosid.id.IdbankIdthe Id of the bank to monitor
ErrorsNULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBankHierarchy
Description

Registers for notification of an updated bank hierarchy structure. BankReceiver.changedChildOfBanks() is invoked when a node experiences a change in its children.

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

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

Parametersosid.id.IdbankIdthe Id of the Bank node to monitor
ErrorsNULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBankHierarchyForDescendants
Description

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

Parametersosid.id.IdbankIdthe Id of the Bank node to monitor
ErrorsNULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.