org.osid.calendaring

Interface CommitmentSearchOrder

All Superinterfaces:

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

public interface CommitmentSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CommitmentSearchOrderRecord	getCommitmentSearchOrderRecord(Type commitmentRecordType) Gets the commitment search order record corresponding to the given commitment record Type.
EventSearchOrder	getEventSearchOrder() Gets the search order for an event.
ResourceSearchOrder	getResourceSearchOrder() Gets the search order for a resource.
void	orderByEvent(SearchOrderStyle style) Specified a preference for ordering results by the event.
void	orderByResource(SearchOrderStyle style) Specified a preference for ordering results by the resource.
boolean	supportsEventSearchOrder() Tests if an EventSearchOrder is available.
boolean	supportsResourceSearchOrder() Tests if a ResourceSearchOrder 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

orderByEvent

void orderByEvent(SearchOrderStyle style)

Specified a preference for ordering results by the event.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsEventSearchOrder

boolean supportsEventSearchOrder()

Tests if an EventSearchOrder is available.

Returns:

true if an event search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEventSearchOrder

EventSearchOrder getEventSearchOrder()

Gets the search order for an event.

Returns:

the event search order

Throws:

UnimplementedException - supportsEventSearchOrder() is false

Compliance:

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

orderByResource

void orderByResource(SearchOrderStyle style)

Specified a preference for ordering results by the resource.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a ResourceSearchOrder is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the search order for a resource.

Returns:

the resource search order

Throws:

UnimplementedException - supportsResourceSearchOrder() is false

Compliance:

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

getCommitmentSearchOrderRecord

CommitmentSearchOrderRecord getCommitmentSearchOrderRecord(Type commitmentRecordType)
                                                           throws OperationFailedException

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

Parameters:

commitmentRecordType - a commitment record type

Returns:

the commitment search order record

Throws:

NullArgumentException - commitmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentRecordType) is false

Compliance:

mandatory - This method must be implemented.