OSID Logo
OSID Specifications
assessment package
Version 3.1.0
Interfaceosid.assessment.AssessmentOfferedSearchSession
Implementsosid.assessment.AssessmentOfferedQuerySession
Used Byosid.assessment.AssessmentManager
osid.assessment.AssessmentProxyManager
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.AssessmentOfferedSearch the assessment offered search
Compliancemandatory This 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.AssessmentOfferedSearchOrder the assessment offered search order
Compliancemandatory This method must be implemented.
MethodgetAssessmentsOfferedBySearch
Description

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

Parametersosid.assessment.AssessmentOfferedQueryassessmentOfferedQuery the assessment offered query
osid.assessment.AssessmentOfferedSearchassessmentOfferedSearch the assessment offered search
Returnosid.assessment.AssessmentOfferedSearchResults the assessment offered search results
ErrorsNULL_ARGUMENT assessmentOfferedQuery or assessmentOfferedSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED assessmentOfferedQuery or assessmentOfferedSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetAssessmentOfferedQueryFromInspector
Description

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

Parametersosid.assessment.AssessmentOfferedQueryInspectorassessmentOfferedQueryInspector an assessment offered query inspector
Returnosid.assessment.AssessmentOfferedQuery the assessment offered query
ErrorsNULL_ARGUMENT assessmentOfferedQueryInspector is null
UNSUPPORTED assessmentOfferedQueryInspector is not of this service
Compliancemandatory This method must be implemented.