org.osid.search

Interface SearchOrder

All Superinterfaces:

OsidSearchOrder, Suppliable

public interface SearchOrder
extends OsidSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
SearchOrderRecord	getSearchOrderRecord(Type queryRecordType) Gets the search order record corresponding to the given query record Type.

Method Detail

getSearchOrderRecord

SearchOrderRecord getSearchOrderRecord(Type queryRecordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

queryRecordType - a query record type

Returns:

the search order record

Throws:

NullArgumentException - queryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(queryRecordType) is false

Compliance:

mandatory - This method must be implemented.