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

This session defines methods to receive notifications on adds/changes to AssessmentPart objects in this Bank. This also includes existing AssessmentParts that may appear or disappear due to changes in the Bank 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 AssessmentPartLookupSession.

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAssessmentPartNotifications
Description

Tests if this user can register for AssessmentPart 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 in bank which are children of this bank in the 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 bank only.

CompliancemandatoryThis method is must be implemented.
MethodreliableAssessmentPartNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAssessmentPartNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAssessmentPartNotification
Description

Acknowledge an assessment part notification.

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

Register for notifications of new assessment parts. AssessmentPartReceiver.newAssessmentParst() is invoked when a new AssessmentPart appears in this bank.

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

Registers for notification of updated bank. AssessmentPartReceiver.changedAssessmentParts() is invoked when an assessment part in this bank is changed.

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

Registers for notification of an updated assessment part. ProvisionableReceiver.changedAssessmentParts() is invoked when the specified assessment part in this bank is changed.

Parametersosid.id.IdassessmentPartIdthe Id of the AssessmentPart to monitor
ErrorsNOT_FOUNDan assessment part was not found in this step matchmaker identified by the given Id
NULL_ARGUMENT assessmentPartId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAssessmentParts
Description

Registers for notification of deleted assessment parts. AssessmentPartReceiver.deletedAssessmentParts() is invoked when an assessment part is deleted or removed from this bank.

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

Registers for notification of a deleted assessment part. AssessmentPartReceiver.deletedAssessmentParts() is invoked when the specified assessment part is deleted or removed from this bank.

Parametersosid.id.IdassessmentPartIdthe Id of the AssessmentPart to monitor
ErrorsNOT_FOUNDan assessment part was not found in this step matchmaker identified by the given Id
NULL_ARGUMENT assessmentPartId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.