OSID Logo
OSID Specifications
ontology package
Version 3.1.0
Interfaceosid.ontology.SubjectSearchResults
Implementsosid.OsidSearchResults
Used Byosid.ontology.SubjectSearchSession
Description

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

MethodgetSubjects
Description

Gets the subject list resulting from the search.

Returnosid.ontology.SubjectList the subject list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetSubjectQueryInspector
Description

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

Returnosid.ontology.SubjectQueryInspector the subject query inspector
Compliancemandatory This 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.TypesubjectSearchRecordType a subject search record type
Returnosid.ontology.records.SubjectSearchResultsRecord the subject search results record
ErrorsNULL_ARGUMENT subjectSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(subjectSearchRecordType) is false
Compliancemandatory This method must be implemented.