Interface | osid.ontology.OntologySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The interface for governing ontology searches. | ||
Method | searchAmongOntologies | ||
Description |
Execute this search among the given list of ontologies. | ||
Parameters | osid.id.IdList | ontologyIds | list of ontologies |
Errors | NULL_ARGUMENT | ontologyIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderOntologyResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.ontology.OntologySearchOrder | ontologySearchOrder | ontology search order |
Errors | NULL_ARGUMENT | ontologySearchOrder is null | |
UNSUPPORTED | ontologySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOntologySearchRecord | ||
Description |
Gets the ontology search record corresponding to the
given ontology search record | ||
Parameters | osid.type.Type | ontologySearchRecordType | an ontology search record type |
Return | osid.ontology.records.OntologySearchRecord | the ontology search record | |
Errors | NULL_ARGUMENT | ontologySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(ontologySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |