OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.AssessmentSearchSession
Implementsosid.assessment.AssessmentQuerySession
Description

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

getAssessmentsByQuery() is the basic search method and returns a list of Assessments. A more advanced search may be performed with getAssessmentsBySearch(). It accepts an AssessmentSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAssessmentsBySearch() returns an AssessmentSearchResults that can be used to access the resulting AssessmentList or be used to perform a search within the result set through AssessmentSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetAssessmentSearch
Description

Gets an assessment search.

Returnosid.assessment.AssessmentSearchthe assessment search
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentSearchOrder
Description

Gets an assessment search order. The AssessmentSearchOrder is supplied to an AssessmentSearch to specify the ordering of results.

Returnosid.assessment.AssessmentSearchOrderthe assessment search order
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.assessment.AssessmentQueryassessmentQuerythe assessment query
osid.assessment.AssessmentSearchassessmentSearchthe assessment search
Returnosid.assessment.AssessmentSearchResultsthe search results
ErrorsNULL_ARGUMENT assessmentQuery or assessmentSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assessmentQuery or assessmentSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentQueryFromInspector
Description

Gets an assessment query from an inspector. The inspector is available from an AssessmentSearchResults.

Parametersosid.assessment.AssessmentQueryInspectorassessmentQueryInspectoran assessment query inspector
Returnosid.assessment.AssessmentQuerythe assessment query
ErrorsNULL_ARGUMENT assessmentQueryInspector is null
UNSUPPORTED assessmentQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.