org.osid.recipe

Interface ProcedureSearchOrder

All Superinterfaces:

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

public interface ProcedureSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ProcedureSearchOrderRecord	getProcedureSearchOrderRecord(Type procedureRecordType) Gets the procedure search order record corresponding to the given procedure 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

getProcedureSearchOrderRecord

ProcedureSearchOrderRecord getProcedureSearchOrderRecord(Type procedureRecordType)
                                                         throws OperationFailedException

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

Parameters:

procedureRecordType - a procedure record type

Returns:

the procedure search order record

Throws:

NullArgumentException - procedureRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(procedureRecordType) is false

Compliance:

mandatory - This method must be implemented.