org.osid.control

Interface SystemSearchOrder

All Superinterfaces:

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

public interface SystemSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
SystemSearchOrderRecord	getSystemSearchOrderRecord(Type systemRecordType) Gets the system search order record corresponding to the given system 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

getSystemSearchOrderRecord

SystemSearchOrderRecord getSystemSearchOrderRecord(Type systemRecordType)
                                                   throws OperationFailedException

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

Parameters:

systemRecordType - a system record type

Returns:

the system search order record

Throws:

NullArgumentException - systemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(systemRecordType) is false

Compliance:

mandatory - This method must be implemented.