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

This session defines methods to receive notifications on adds/changes to AssessmentTaken objects in this Bank. 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 AssessmentTakenLookupSession.

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.
MethodcanRegisterForAssessmentTakenNotifications
Description

Tests if this user can register for AssessmentTaken 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 assessments taken in banks 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 for assessments taken to this bank only.

CompliancemandatoryThis method is must be implemented.
MethodreliableAssessmentTakenNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAssessmentTakenNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAssessmentTakenNotification
Description

Acknowledge an assessment taken notification.

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

Register for notifications of new assessments taken in this assessment bank. AssessmentTakenReceiver.newAssessmentsTaken() is invoked when a new AssessmentTaken appears in this assessment bank.

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

Register for notifications of new assessments taken for a resource. AssessmentTakenReceiver.newAssessmenstTaken() is invoked when a new AssessmentTaken appears in this assessment bank.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT assessmentOfferedId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAssessmentsTakenForAssessmentOffered
Description

Register for notifications of new assessments taken for an assessment offered. AssessmentTakenReceiver.newAssessmentsTaken() is invoked when a new AssessmentTaken appears in this assessment bank.

Parametersosid.id.IdassessmentOfferedIdthe Id of the AssessmentOffered to monitor
ErrorsNULL_ARGUMENT assessmentOfferedId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAssessmentsTakenForAssessment
Description

Register for notifications of new assessments taken for an assessment. AssessmentTakenReceiver.newAssessmentsTaken() is invoked when a new AssessmentTaken appears in this assessment bank.

Parametersosid.id.IdassessmentIdthe Id of the Assessment to monitor
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAssessmentsTaken
Description

Registers for notification of updated assessments taken. AssessmentTakenReceiver.changedAssessmentsTaken() is invoked when an assessment taken in this assessment bank is changed.

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

Register for notifications of changed assessments taken for a resource. AssessmentTakenReceiver.changedAssessmentsTaken() is invoked when an AssessmentTaken is changed in this assessment bank.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT assessmentOfferedId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAssessmentsTakenForAssessmentOffered
Description

Register for notifications of changed assessments taken for an assessment offered. AssessmentTakenReceiver.changedAssessmentsTaken() is invoked when an AssessmentTaken is changed in this assessment bank.

Parametersosid.id.IdassessmentOfferedIdthe Id of the AssessmentOffered to monitor
ErrorsNULL_ARGUMENT assessmentOfferedId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAssessmentsTakenForAssessment
Description

Register for notifications of changed assessments taken for an assessment. AssessmentTakenReceiver.changedAssessmentsTaken() is invoked when an AssessmentTaken is changed in this assessment bank.

Parametersosid.id.IdassessmentIdthe Id of the Assessment to monitor
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAssessmentTaken
Description

Registers for notification of an updated assessment taken. AssessmentTakenReceiver.changedAssessmentsTaken() is invoked when the specified assessment taken in this assessment bank is changed.

Parametersosid.id.IdassessmentTakenIdthe Id of the AssessmentTaken to monitor
ErrorsNULL_ARGUMENT assessmentTakenId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAssessmentsTaken
Description

Registers for notification of deleted assessments taken. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when an assessment taken is removed from this assessment bank.

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

Register for notifications of deleted assessments taken for a resource. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when an AssessmentTaken is removed from this assessment bank.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT assessmentOfferedId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAssessmentsTakenForAssessmentOffered
Description

Register for notifications of deleted assessments taken for an assessment offered. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when an AssessmentTaken is removed from this assessment bank.

Parametersosid.id.IdassessmentOfferedIdthe Id of the AssessmentOffered to monitor
ErrorsNULL_ARGUMENT assessmentOfferedId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAssessmentsTakenForAssessment
Description

Register for notifications of deleted assessments taken for an assessment. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when an AssessmentTaken is removed from this assessment bank.

Parametersosid.id.IdassessmentIdthe Id of the Assessment to monitor
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAssessmentTaken
Description

Registers for notification of a deleted assessment taken. AssessmentTakenReceiver.deletedAssessmentsTaken() is invoked when the specified assessment taken is removed from this assessment bank.

Parametersosid.id.IdassessmentTakenIdthe Id of the AssessmentTaken to monitor
ErrorsNULL_ARGUMENT assessmentTakenId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.