OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ObjectiveBankNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to ObjectiveBank 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 i

MethodcanRegisterForObjectiveBankNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableObjectiveBankNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeObjectiveBankNotification
Description

Acknowledge an objective bank notification.

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

Register for notifications of new objective banks. ObjectiveBankReceiver.newObjectiveBanks() is invoked when a new ObjectiveBank is created.

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

Registers for notification of updated objective banks. ObjectiveBankReceiver.changedObjectiveBanks() is invoked when an objective bank is changed.

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

Registers for notification of an updated objective bank. ObjectiveBankReceiver.changedObjectiveBanks() is invoked when the specified objective bank is changed.

Parametersosid.id.IdobjectiveBankIdthe Id of the objective bank to monitor
ErrorsNULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedObjectiveBanks
Description

Registers for notification of deleted objective banks. ObjectiveBankReceiver.deletedObjectiveBanks() is invoked when a calenedar is deleted.

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

Registers for notification of a deleted objective bank. ObjectiveBankReceiver.deletedObjectiveBanks() is invoked when the specified objective bank is deleted.

Parametersosid.id.IdobjectiveBankIdthe Id of the objective bank to monitor
ErrorsNULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedObjectiveBankHierarchy
Description

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

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

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

Parametersosid.id.IdobjectiveBankIdthe Id of the ObjectiveBank node to monitor
ErrorsNULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedObjectiveBankHierarchyForDescendants
Description

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

Parametersosid.id.IdobjectiveBankIdthe Id of the ObjectiveBank node to monitor
ErrorsNULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.