org.osid.installation

Interface SiteSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface SiteSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
SiteSearchOrderRecord	getSiteSearchOrderRecord(Type siteRecordType) Gets the site search order record corresponding to the given package 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

Method Detail

getSiteSearchOrderRecord

SiteSearchOrderRecord getSiteSearchOrderRecord(Type siteRecordType)
                                               throws OperationFailedException

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

Parameters:

siteRecordType - a site record type

Returns:

the site search order record

Throws:

NullArgumentException - siteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(siteRecordType) is false

Compliance:

mandatory - This method must be implemented.