org.osid.topology

Interface GraphSearchOrder

All Superinterfaces:

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

public interface GraphSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
GraphSearchOrderRecord	getGraphSearchOrderRecord(Type graphRecordType) Gets the graph search order record corresponding to the given graph 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

getGraphSearchOrderRecord

GraphSearchOrderRecord getGraphSearchOrderRecord(Type graphRecordType)
                                                 throws OperationFailedException

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

Parameters:

graphRecordType - a graph record type

Returns:

the graph search order record

Throws:

NullArgumentException - graphRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(graphRecordType) is false

Compliance:

mandatory - This method must be implemented.