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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Modifier and Type	Method	Description
void	orderByActive(SearchOrderStyle style)	Specifies a preference for ordering the result set by the active status.
void	orderByDisabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively disabled status.
void	orderByEnabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively enabled status.
void	orderByOperational(SearchOrderStyle style)	Specifies a preference for ordering the results by the operational status.

Methods inherited from interface OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Modifier and Type	Method	Description
ResourceSearchOrder	getProviderSearchOrder()	Gets the search order interface for a provider.
void	orderByProvider(SearchOrderStyle style)	Specifies a preference for ordering the results by provider.
boolean	supportsProviderSearchOrder()	Tests if a ProviderSearchOrder interface is available.

Method Details

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 {@code supportsTimePeriodSearchOrder()} is {@code 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.