OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ProficiencySearch
Implementsosid.OsidSearch
Description

The search interface for governing proficiency searches.

MethodsearchAmongProficiencies
Description

Execute this search among the given list of proficiencies.

Parametersosid.id.IdListproficiencyIdslist of proficiencies
ErrorsNULL_ARGUMENT proficiencyIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProficiencyResults
Description

Specify an ordering to the search results.

Parametersosid.learning.ProficiencySearchOrderproficiencySearchOrderproficiency search order
ErrorsNULL_ARGUMENT proficiencySearchOrder is null
UNSUPPORTED proficiencySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProficiencySearchRecord
Description

Gets the proficiency search record corresponding to the given proficiency search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeproficiencySearchRecordTypea proficiency search record type
Returnosid.learning.records.ProficiencySearchRecordthe proficiency search record
ErrorsNULL_ARGUMENT proficiencySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(proficiencySearchRecordType) is false
CompliancemandatoryThis method must be implemented.