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

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

getAssessmentsTakenByQuery() is the basic search method and returns a list of AssessmentTaken elements. A more advanced search may be performed with getAssessmentsTakenBySearch(). It accepts an AssessmentTakenSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAssessmentsTakenBySearch() returns an AssessmentTakenSearchResults that can be used to access the resulting AssessmenTakenList or be used to perform a search within the result set through AssessmentTakenSearch.

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 query records indicated by their respective record types. The query record is accessed via the AssessmentTakenQuery.

MethodgetAssessmentTakenSearch
Description

Gets an assessment taken search.

Returnosid.assessment.AssessmentTakenSearchthe assessment taken search
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentTakenSearchOrder
Description

Gets an assessment taken search order. The AssessmentTakenSearchOrder is supplied to an AssessmentTakenSearch to specify the ordering of results.

Returnosid.assessment.AssessmentTakenSearchOrderthe assessment taken search order
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenBySearch
Description

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

Parametersosid.assessment.AssessmentTakenQueryassessmentTakenQuerythe assessment taken query
osid.assessment.AssessmentTakenSearchassessmentTakenSearchthe assessment taken search
Returnosid.assessment.AssessmentTakenSearchResultsthe assessment taken search results
ErrorsNULL_ARGUMENT assessmentTakenQuery or assessmentTakenSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assessmentTakenQuery or assessmentTakenSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentTakenQueryFromInspector
Description

Gets an assessment taken query from an inspector. The inspector is available from an AssessmentTakenSearchResults.

Parametersosid.assessment.AssessmentTakenQueryInspectorassessmentTakenQueryInspectoran assessment taken query inspector
Returnosid.assessment.AssessmentTakenQuerythe assessment taken query
ErrorsNULL_ARGUMENT assessmentTakenQueryInspector is null
UNSUPPORTED assessmentTakenQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.