org.osid.resourcing

Interface FoundrySearchOrder

All Superinterfaces:

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

public interface FoundrySearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
FoundrySearchOrderRecord	getFoundrySearchOrderRecord(Type foundryRecordType) Gets the foundry search order record corresponding to the given foundry 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

getFoundrySearchOrderRecord

FoundrySearchOrderRecord getFoundrySearchOrderRecord(Type foundryRecordType)
                                                     throws OperationFailedException

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

Parameters:

foundryRecordType - a foundry record type

Returns:

the foundry search order record

Throws:

NullArgumentException - foundryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(foundryRecordType) is false

Compliance:

mandatory - This method must be implemented.