org.osid.ontology

Interface OntologySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface OntologySearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
OntologySearchOrderRecord	getOntologySearchOrderRecord(Type ontologyRecordType) Gets the ontology search order record corresponding to the given ontology record Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getOntologySearchOrderRecord

OntologySearchOrderRecord getOntologySearchOrderRecord(Type ontologyRecordType)
                                                       throws OperationFailedException

Gets the ontology search order record corresponding to the given ontology record Type. Multiple retrievals return the same underlying object.

Parameters:

ontologyRecordType - an ontology record type

Returns:

the ontology search order record

Throws:

NullArgumentException - ontologyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ontologyRecordType) is false

Compliance:

mandatory - This method must be implemented.