org.osid.process

Interface StateSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface StateSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
StateSearchOrderRecord	getStateSearchOrderRecord(Type stateRecordType) Gets the state search order record corresponding to the given state 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

Method Detail

getStateSearchOrderRecord

StateSearchOrderRecord getStateSearchOrderRecord(Type stateRecordType)
                                                 throws OperationFailedException

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

Parameters:

stateRecordType - a state record type

Returns:

the state search order record

Throws:

NullArgumentException - stateRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stateRecordType) is false

Compliance:

mandatory - This method must be implemented.