OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.SubjectSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetSubjects
Description

Gets the subject list resulting from the search.

Returnosid.ontology.SubjectListthe subject list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSubjectQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.ontology.SubjectQueryInspectorthe subject query inspector
CompliancemandatoryThis method must be implemented.
MethodgetSubjectSearchResultsRecord
Description

Gets the subject search results 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.SubjectSearchResultsRecordthe subject search results record
ErrorsNULL_ARGUMENT subjectSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subjectSearchRecordType) is false
CompliancemandatoryThis method must be implemented.