org.osid.configuration

Interface ConfigurationSearchOrder

All Superinterfaces:

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

public interface ConfigurationSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurationSearchOrderRecord	getConfigurationSearchOrderRecord(Type configurationRecordType) Gets the configuration search order record corresponding to the given configuration 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

getConfigurationSearchOrderRecord

ConfigurationSearchOrderRecord getConfigurationSearchOrderRecord(Type configurationRecordType)
                                                                 throws OperationFailedException

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

Parameters:

configurationRecordType - a configuration record type

Returns:

the configuration search order record

Throws:

NullArgumentException - configurationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(configurationRecordType) is false

Compliance:

mandatory - This method must be implemented.