org.osid.ontology

Interface OntologySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface OntologySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
OntologyList	getOntologies() Gets the ontology list resulting from the search.
OntologyQueryInspector	getOntologyQueryInspector() Gets the inspector for the query to examine the terms used in the search.
OntologySearchResultsRecord	getOntologySearchResultsRecord(Type ontologySearchRecordType) Gets the ontology search results record corresponding to the given calndar search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getOntologies

OntologyList getOntologies()

Gets the ontology list resulting from the search.

Returns:

the ontology list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getOntologyQueryInspector

OntologyQueryInspector getOntologyQueryInspector()

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

Returns:

the ontology query inspector

Compliance:

mandatory - This method must be implemented.

getOntologySearchResultsRecord

OntologySearchResultsRecord getOntologySearchResultsRecord(Type ontologySearchRecordType)
                                                           throws OperationFailedException

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

Parameters:

ontologySearchRecordType - an ontology search record type

Returns:

the ontology search results record

Throws:

NullArgumentException - ontologySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ontologySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.