org.osid.resourcing

Interface EffortSearchOrder

All Superinterfaces:

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

public interface EffortSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CommissionSearchOrder	getCommissionSearchOrder() Gets the commission search order.
EffortSearchOrderRecord	getEffortSearchOrderRecord(Type effortRecordType) Gets the effort search order record corresponding to the given effort record Type.
ResourceSearchOrder	getResourceSearchOrder() Gets the resource search order.
void	orderByCommission(SearchOrderStyle style) Orders the results by the commission.
void	orderByResource(SearchOrderStyle style) Orders the results by resource.
void	orderByTimeSpent(SearchOrderStyle style) Orders the results by the time spent.
boolean	supportsCommissionSearchOrder() Tests if a commission search order is available.
boolean	supportsResourceSearchOrder() Tests if a resource search 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

orderByResource

void orderByResource(SearchOrderStyle style)

Orders the results by resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a resource search order 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 resource search order.

Returns:

the resource search order

Throws:

IllegalStateException - supportsResourceSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByCommission

void orderByCommission(SearchOrderStyle style)

Orders the results by the commission.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCommissionSearchOrder

boolean supportsCommissionSearchOrder()

Tests if a commission search order is available.

Returns:

true if a commission search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCommissionSearchOrder

CommissionSearchOrder getCommissionSearchOrder()

Gets the commission search order.

Returns:

the commission search order

Throws:

IllegalStateException - supportsCommissionSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByTimeSpent

void orderByTimeSpent(SearchOrderStyle style)

Orders the results by the time spent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getEffortSearchOrderRecord

EffortSearchOrderRecord getEffortSearchOrderRecord(Type effortRecordType)
                                                   throws OperationFailedException

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

Parameters:

effortRecordType - an effort record type

Returns:

the effort search order record

Throws:

NullArgumentException - effortRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(effortRecordType) is false

Compliance:

mandatory - This method must be implemented.