Interface CampusSearchOrder

All Superinterfaces:

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

public interface CampusSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
CampusSearchOrderRecord	getCampusSearchOrderRecord(Type campusRecordType)	Gets the campus search order record corresponding to the given campus record Type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Methods inherited from interface OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Details

getCampusSearchOrderRecord

CampusSearchOrderRecord getCampusSearchOrderRecord(Type campusRecordType)
                                            throws OperationFailedException

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

Parameters:

campusRecordType - a campus record type

Returns:

the campus search order record

Throws:

NullArgumentException - campusRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(campusRecordType) is false

Compliance:

mandatory - This method must be implemented.