org.osid.offering

Interface OfferingSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface OfferingSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CanonicalUnitSearchOrder	getCanonicalUnitSearchOrder() Gets the canonical unit order.
OfferingSearchOrderRecord	getOfferingSearchOrderRecord(Type offeringRecordType) Gets the offering search order record corresponding to the given offering record Type.
TimePeriodSearchOrder	getTimePeriodSearchOrder() Gets the time period order.
void	orderByCanonicalUnit(SearchOrderStyle style) Specifies a preference for ordering the result set by canonical unit.
void	orderByCode(SearchOrderStyle style) Specifies a preference for ordering the result set by offering code.
void	orderByTimePeriod(SearchOrderStyle style) Specifies a preference for ordering the result set by time period.
void	orderByTitle(SearchOrderStyle style) Specifies a preference for ordering the result set by offering title.
boolean	supportsCanonicalUnitSearchOrder() Tests if a canonical unit order is available.
boolean	supportsTimePeriodSearchOrder() Tests if a time period order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByCanonicalUnit

void orderByCanonicalUnit(SearchOrderStyle style)

Specifies a preference for ordering the result set by canonical unit.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitSearchOrder

boolean supportsCanonicalUnitSearchOrder()

Tests if a canonical unit order is available.

Returns:

true if a canonical unit order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitSearchOrder

CanonicalUnitSearchOrder getCanonicalUnitSearchOrder()

Gets the canonical unit order.

Returns:

the canonical unit search order

Throws:

UnimplementedException - supportsCanonicalUnitSearchOrder() is false

Compliance:

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

orderByTimePeriod

void orderByTimePeriod(SearchOrderStyle style)

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

Parameters:

style - a 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.

orderByTitle

void orderByTitle(SearchOrderStyle style)

Specifies a preference for ordering the result set by offering title.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCode

void orderByCode(SearchOrderStyle style)

Specifies a preference for ordering the result set by offering code.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getOfferingSearchOrderRecord

OfferingSearchOrderRecord getOfferingSearchOrderRecord(Type offeringRecordType)
                                                       throws OperationFailedException

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

Parameters:

offeringRecordType - an offering record type

Returns:

the offering search order record

Throws:

NullArgumentException - offeringRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offeringRecordType) is false

Compliance:

mandatory - This method must be implemented.