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

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetAssessmentOfferedSearch
Description

Gets an assessment offered search.

Returnosid.assessment.AssessmentOfferedSearchthe assessment offered search
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentOfferedSearchOrder
Description

Gets an assessment offered search order. The AssessmentOfferedSearchOrder is supplied to an AssessmentOfferedSearch to specify the ordering of results.

Returnosid.assessment.AssessmentOfferedSearchOrderthe assessment offered search order
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsOfferedBySearch
Description

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

Parametersosid.assessment.AssessmentOfferedQueryassessmentOfferedQuerythe assessment offered query
osid.assessment.AssessmentOfferedSearchassessmentOfferedSearchthe assessment offered search
Returnosid.assessment.AssessmentOfferedSearchResultsthe assessment offered search results
ErrorsNULL_ARGUMENT assessmentOfferedQuery or assessmentOfferedSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assessmentOfferedQuery or assessmentOfferedSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentOfferedQueryFromInspector
Description

Gets an assessment offered query from an inspector. The inspector is available from an AssessmentOfferedSearchResults.

Parametersosid.assessment.AssessmentOfferedQueryInspectorassessmentOfferedQueryInspectoran assessment offered query inspector
Returnosid.assessment.AssessmentOfferedQuerythe assessment offered query
ErrorsNULL_ARGUMENT assessmentOfferedQueryInspector is null
UNSUPPORTED assessmentOfferedQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.