org.osid.tracking

Interface FrontOfficeSearchOrder

All Superinterfaces:

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

public interface FrontOfficeSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
FrontOfficeSearchOrderRecord	getFrontOfficeSearchOrderRecord(Type frontOfficeRecordType) Gets the front office search order record corresponding to the given front office 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

getFrontOfficeSearchOrderRecord

FrontOfficeSearchOrderRecord getFrontOfficeSearchOrderRecord(Type frontOfficeRecordType)
                                                             throws OperationFailedException

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

Parameters:

frontOfficeRecordType - a front office record type

Returns:

the front office search order record

Throws:

NullArgumentException - frontOfficeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(frontOfficeRecordType) is false

Compliance:

mandatory - This method must be implemented.