org.osid.learning

Interface ActivitySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable

public interface ActivitySearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ActivitySearchOrderRecord	getActivitySearchOrderRecord(Type activityRecordType) Gets the activity search order record corresponding to the given activity record Type.
ObjectiveSearchOrder	getObjectiveSearchOrder() Gets an objective search order.
void	orderByObjective(SearchOrderStyle style) Specifies a preference for ordering the result set by the objective.
boolean	supportsObjectiveSearchOrder() Tests if an objective search order is available.

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

Method Detail

orderByObjective

void orderByObjective(SearchOrderStyle style)

Specifies a preference for ordering the result set by the objective.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsObjectiveSearchOrder

boolean supportsObjectiveSearchOrder()

Tests if an objective search order is available.

Returns:

true if an objective search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getObjectiveSearchOrder

ObjectiveSearchOrder getObjectiveSearchOrder()

Gets an objective search order.

Returns:

an objective search order

Throws:

UnimplementedException - supportsObjectiveSearchOrder() is false

Compliance:

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

getActivitySearchOrderRecord

ActivitySearchOrderRecord getActivitySearchOrderRecord(Type activityRecordType)
                                                       throws OperationFailedException

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

Parameters:

activityRecordType - an activity record type

Returns:

the activity search order record

Throws:

NullArgumentException - activityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRecordType) is false

Compliance:

mandatory - This method must be implemented.