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

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

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

MethodgetBankId
Description

Gets the Bank Id associated with this session.

Returnosid.id.Idthe Bank Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBank
Description

Gets the Bank associated with this session.

Returnosid.assessment.Bankthe Bank associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForItemNotifications
Description

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

Federates the view for methods in this session. A federated view will include notifications for assessment items in assessment banks which are children of this assessment bank in the assessment bank hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBankView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableItemNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableItemNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeItemNotification
Description

Acknowledge an item notification.

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

Register for notifications of new assessment items. ItemReceiver.newItems() is invoked when a new Item is created.

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

Registers for notification of updated assessment items. ItemReceiver.changedItems() is invoked when an assessment item is changed.

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

Registers for notification of an updated assessment item. ItemReceiver.changedItems() is invoked when the specified assessment item is changed.

Parametersosid.id.IditemIdthe Id of the Assessment to monitor
ErrorsNOT_FOUNDan item was not found identified by the given Id
NULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedItems
Description

Registers for notification of deleted assessment items. ItemReceiver.deletedItems() is invoked when an assessment item is removed from the assessment bank.

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

Registers for notification of a deleted assessment item. ItemReceiver.deletedItems() is invoked when the specified assessment item is removed from the assessment bank.

Parametersosid.id.IditemIdthe Id of the Item to monitor
ErrorsNOT_FOUNDan Item was not found identified by the given Id
NULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.