Interface OntologySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface OntologySearch
extends OsidSearch

The interface for governing ontology searches.

Method Summary

Modifier and Type	Method	Description
OntologySearchRecord	getOntologySearchRecord(Type ontologySearchRecordType)	Gets the ontology search record corresponding to the given ontology search record Type.
void	orderOntologyResults(OntologySearchOrder ontologySearchOrder)	Specify an ordering to the search results.
void	searchAmongOntologies(IdList ontologyIds)	Execute this search among the given list of ontologies.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongOntologies

void searchAmongOntologies(IdList ontologyIds)

Execute this search among the given list of ontologies.

Parameters:

ontologyIds - list of ontologies

Throws:

NullArgumentException - ontologyIds is null

Compliance:

mandatory - This method must be implemented.

orderOntologyResults

void orderOntologyResults(OntologySearchOrder ontologySearchOrder)

Specify an ordering to the search results.

Parameters:

ontologySearchOrder - ontology search order

Throws:

NullArgumentException - ontologySearchOrder is null

UnsupportedException - ontologySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getOntologySearchRecord

OntologySearchRecord getOntologySearchRecord(Type ontologySearchRecordType)
                                      throws OperationFailedException

Gets the ontology search record corresponding to the given ontology 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 record

Throws:

NullArgumentException - ontologySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ontologySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.