org.osid.personnel

Interface RealmSearchOrder

All Superinterfaces:

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

public interface RealmSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RealmSearchOrderRecord	getRealmSearchOrderRecord(Type realmRecordType) Gets the realm search record order corresponding to the given realm 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

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getRealmSearchOrderRecord

RealmSearchOrderRecord getRealmSearchOrderRecord(Type realmRecordType)
                                                 throws OperationFailedException

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

Parameters:

realmRecordType - a realm record type

Returns:

the realm search order record interface

Throws:

NullArgumentException - realmRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(realmRecordType) is false

Compliance:

mandatory - This method must be implemented.