OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.SubjectSearch
Implementsosid.OsidSearch
Description

SubjectSearch defines the interface for specifying subject search options.

MethodsearchAmongSubjects
Description

Execute this search among the given list of subjects.

Parametersosid.id.IdListsubjectIdslist of subjects
ErrorsNULL_ARGUMENT subjectIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSubjectResults
Description

Specify an ordering to the search results.

Parametersosid.ontology.SubjectSearchOrdersubjectSearchOrdersubject search order
ErrorsNULL_ARGUMENT subjectSearchOrder is null
UNSUPPORTED subjectSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSubjectSearchRecord
Description

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

Parametersosid.type.TypesubjectSearchRecordTypea subject search record type
Returnosid.ontology.records.SubjectSearchRecordthe subject search record
ErrorsNULL_ARGUMENT subjectSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subjectSearchRecordType) is false
CompliancemandatoryThis method must be implemented.