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

This session provides methods for querying AssessmentOffered objects. The search query is constructed using the AssessmentOfferedQuery.

This session defines views that offer differing behaviors for searching.

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

Asessments offered may have a query record indicated by their respective record types. The query record is accessed via the AssessmentOfferedQuery. The returns in this session may not be cast directly to these interfaces.

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

Tests if this user can perform AssessmentOffered 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 wish 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 offered 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.
MethodgetAssessmentOfferedQuery
Description

Gets an assessment offered query.

Returnosid.assessment.AssessmentOfferedQuerythe assessment offered query
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsOfferedByQuery
Description

Gets a list of AssessmentOffered elements matching the given assessment offered query.

Parametersosid.assessment.AssessmentOfferedQueryassessmentOfferedQuerythe assessment offered query
Returnosid.assessment.AssessmentOfferedListthe returned AssessmentOfferedList
ErrorsNULL_ARGUMENT assessmentOfferedQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assessmentOfferedQuery is not of this service
CompliancemandatoryThis method must be implemented.