OSID Logo
OSID Specifications
assessment authoring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.authoring.AssessmentPartSearchSession
Implementsosid.assessment.authoring.AssessmentPartQuerySession
Description

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

getAssessmentPartsByQuery() is the basic search method and returns a list of AssessmentParts. A more advanced search may be performed with getAssessmentPartsBySearch(). It accepts an AssessmentPartSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. getAssessmentPartsBySearch() returns an AssessmentPartSearchResults that can be used to access the resulting AssessmentPartList or be used to perform a search within the result set through AssessmentPartSearch.

This session defines views that offer differing behaviors for searching.

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

AssessmentParts may have a query record indicated by their respective record types. Thequery record is accessed via the AssessmentPartQuery.

MethodgetAssessmentPartSearch
Description

Gets an assessment part search.

Returnosid.assessment.authoring.AssessmentPartSearchthe assessment part search
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentPartSearchOrder
Description

Gets an assessment part search order. The AssessmentPartSearchOrder is supplied to an AssessmentPartSearch to specify the ordering of results.

Returnosid.assessment.authoring.AssessmentPartSearchOrderthe assessment part search order
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentPartsBySearch
Description

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

Parametersosid.assessment.authoring.AssessmentPartQueryassessmentPartQuerythe assessment part query
osid.assessment.authoring.AssessmentPartSearchassessmentPartSearchthe assessment part search
Returnosid.assessment.authoring.AssessmentPartSearchResultsthe returned search results
ErrorsNULL_ARGUMENT assessmentPartQuery or assessmentPartSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED assessmentPartQuery or assessmentPartSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentPartQueryFromInspector
Description

Gets an assessment part query from an inspector. The inspector is available from an AssessmentPartSearchResults.

Parametersosid.assessment.authoring.AssessmentPartQueryInspectorassessmentPartQueryInspectoran assessment part query inspector
Returnosid.assessment.authoring.AssessmentPartQuerythe assessment part query
ErrorsNULL_ARGUMENT assessmentPartQueryInspector is null
UNSUPPORTED assessmentPartQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.