Interface | osid.assessment.ItemNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getBankId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bank Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBank | ||
Description |
Gets the | ||
Return | osid.assessment.Bank | the Bank associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForItemNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedBankView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBankView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this assessment bank only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableItemNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableItemNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeItemNotification | ||
Description |
Acknowledge an item notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewItems | ||
Description |
Register for notifications of new assessment items.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedItems | ||
Description |
Registers for notification of updated assessment items.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedItem | ||
Description |
Registers for notification of an updated assessment
item. | ||
Parameters | osid.id.Id | itemId | the Id of the Assessment to monitor |
Errors | NOT_FOUND | an item was not found identified by the given Id
| |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedItems | ||
Description |
Registers for notification of deleted assessment items.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedItem | ||
Description |
Registers for notification of a deleted assessment
item. | ||
Parameters | osid.id.Id | itemId | the Id of the Item to monitor |
Errors | NOT_FOUND | an Item was not found identified by the given Id
| |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. |