org.osid.calendaring

Interface SupersedingEventSearchOrder

All Superinterfaces:

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

public interface SupersedingEventSearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
EventSearchOrder	getSupersededEventSearchOrder() Gets the search order for the superseded event.
EventSearchOrder	getSupersedingEventSearchOrder() Gets the search order for the superseding event.
SupersedingEventSearchOrderRecord	getSupersedingEventSearchOrderRecord(Type supersedingEventRecordType) Gets the superseding event search order record corresponding to the given superseding event record Type.
void	orderBySupersededDate(SearchOrderStyle style) Specified a preference for ordering results by the superseded date.
void	orderBySupersededEvent(SearchOrderStyle style) Specified a preference for ordering results by the superseded event.
void	orderBySupersededEventPosition(SearchOrderStyle style) Specified a preference for ordering results by the superseded event position.
void	orderBySupersedingEvent(SearchOrderStyle style) Specified a preference for ordering results by the superseding event.
boolean	supportsSupersededEventSearchOrder() Tests if an EventSearchOrder is available.
boolean	supportsSupersedingEventSearchOrder() Tests if an EventSearchOrder is available.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

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

Method Detail

orderBySupersededEvent

void orderBySupersededEvent(SearchOrderStyle style)

Specified a preference for ordering results by the superseded event.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSupersededEventSearchOrder

boolean supportsSupersededEventSearchOrder()

Tests if an EventSearchOrder is available.

Returns:

true if an event search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSupersededEventSearchOrder

EventSearchOrder getSupersededEventSearchOrder()

Gets the search order for the superseded event.

Returns:

the event search order

Throws:

UnimplementedException - supportsSupersededEventSearchOrder() is false

Compliance:

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

orderBySupersedingEvent

void orderBySupersedingEvent(SearchOrderStyle style)

Specified a preference for ordering results by the superseding event.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventSearchOrder

boolean supportsSupersedingEventSearchOrder()

Tests if an EventSearchOrder is available.

Returns:

true if an event search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSupersedingEventSearchOrder

EventSearchOrder getSupersedingEventSearchOrder()

Gets the search order for the superseding event.

Returns:

the event search order

Throws:

UnimplementedException - supportsSupersedingEventSearchOrder() is false

Compliance:

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

orderBySupersededDate

void orderBySupersededDate(SearchOrderStyle style)

Specified a preference for ordering results by the superseded date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySupersededEventPosition

void orderBySupersededEventPosition(SearchOrderStyle style)

Specified a preference for ordering results by the superseded event position.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getSupersedingEventSearchOrderRecord

SupersedingEventSearchOrderRecord getSupersedingEventSearchOrderRecord(Type supersedingEventRecordType)
                                                                       throws OperationFailedException

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

Parameters:

supersedingEventRecordType - a superseding event record type

Returns:

the superseding event search order record

Throws:

NullArgumentException - supersedingEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventRecordType) is false

Compliance:

mandatory - This method must be implemented.