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

This session provides methods for searching among AssessmentTaken objects. The search query is constructed using the AssessmentTakenQuery.

This session defines views that offer differing behaviors for searching.

  • federated bank view: searches include assessments taken in banks of which this bank is an ancestor in the bank hierarchy
  • isolated bank view: searches are restricted to assessments taken in this bank

Assessments taken may have a query record indicated by their respective query record types. The query record is accessed via the AssessmentTakenQuery.

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

Tests if this user can perform AssessmentTaken searches. 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 search operations to unauthorized users.

Returnboolean false if search 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 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 searches to this bank only.

CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentTakenQuery
Description

Gets an assessment taken query.

Returnosid.assessment.AssessmentTakenQuerythe assessment taken query
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByQuery
Description

Gets a list of AssessmentTaken elements matching the given assessment taken query.

Parametersosid.assessment.AssessmentTakenQueryassessmentTakenQuerythe assessment taken query
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTakenList
ErrorsNULL_ARGUMENT assessmentTakenQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assessmentTakenQuery is not of this service
CompliancemandatoryThis method must be implemented.