org.osid.repository

Interface RepositorySearchOrder

All Superinterfaces:

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

public interface RepositorySearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RepositorySearchOrderRecord	getRepositorySearchOrderRecord(Type repositoryRecordType) Gets the repository search order record corresponding to the given repository 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

getRepositorySearchOrderRecord

RepositorySearchOrderRecord getRepositorySearchOrderRecord(Type repositoryRecordType)
                                                           throws OperationFailedException

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

Parameters:

repositoryRecordType - a repository record type

Returns:

the repository search order record

Throws:

NullArgumentException - repositoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(repositoryRecordType) is false

Compliance:

mandatory - This method must be implemented.