org.osid.recognition

Interface ConvocationSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface ConvocationSearchOrder
extends OsidGovernatorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ConvocationSearchOrderRecord	getConvocationSearchOrderRecord(Type convocationRecordType) Gets the convocation search order record corresponding to the given convocation record Type.
TimePeriodSearchOrder	getTimePeriodSearchOrder() Gets the time period order.
void	orderByDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the date.
void	orderByTimePeriod(SearchOrderStyle style) Specifies a preference for ordering the result set by the time period.
boolean	supportsTimePeriodSearchOrder() Tests if a time period order is available.

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.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

orderByDate

void orderByDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTimePeriod

void orderByTimePeriod(SearchOrderStyle style)

Specifies a preference for ordering the result set by the time period.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTimePeriodSearchOrder

boolean supportsTimePeriodSearchOrder()

Tests if a time period order is available.

Returns:

true if a time period order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTimePeriodSearchOrder

TimePeriodSearchOrder getTimePeriodSearchOrder()

Gets the time period order.

Returns:

the time period search order

Throws:

UnimplementedException - supportsTimePeriodSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsTimePeriodSearchOrder() is true.

getConvocationSearchOrderRecord

ConvocationSearchOrderRecord getConvocationSearchOrderRecord(Type convocationRecordType)
                                                             throws OperationFailedException

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

Parameters:

convocationRecordType - a convocation record type

Returns:

the convocation search order record

Throws:

NullArgumentException - convocationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(convocationRecordType) is false

Compliance:

mandatory - This method must be implemented.