OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ProficiencySearchSession
Implementsosid.learning.ProficiencyQuerySession
Description

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

getProficienciesByQuery() is the basic search method and returns a list of Proficiencies. A more advanced search may be performed with getProficienciesBySearch(). It accepts a ProficiencySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProficienciesBySearch() returns a ProficiencySearchResults that can be used to access the resulting ProficiencyList or be used to perform a search within the result set through ProficiencySearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetProficiencySearch
Description

Gets a proficiency search.

Returnosid.learning.ProficiencySearchthe proficiency search
CompliancemandatoryThis method must be implemented.
MethodgetProficiencySearchOrder
Description

Gets a proficiency search order. The ProficiencySearchOrder is supplied to a ProficiencySearch to specify the ordering of results.

Returnosid.learning.ProficiencySearchOrderthe proficiency search order
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesBySearch
Description

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

Parametersosid.learning.ProficiencyQueryproficiencyQuerythe proficiency query
osid.learning.ProficiencySearchproficiencySearchthe proficiency search
Returnosid.learning.ProficiencySearchResultsthe returned search results
ErrorsNULL_ARGUMENT proficiencyQuery or proficiencySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED proficiencyQuery or proficiencySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProficiencyQueryFromInspector
Description

Gets a proficiency query from an inspector. The inspector is available from a ProficiencySearchResults.

Parametersosid.learning.ProficiencyQueryInspectorproficiencyQueryInspectora proficiency query inspector
Returnosid.learning.ProficiencyQuerythe proficiency query
ErrorsNULL_ARGUMENT proficiencyQueryInspector is null
UNSUPPORTED proficiencyQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.