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

Modifier and Type	Method	Description
ActivitySearchOrderRecord	getActivitySearchOrderRecord(Type activityRecordType)	Gets the activity search order record corresponding to the given activity record Type .Multiple retrievals return the same underlying object.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

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 {@code supportsObjectiveSearchOrder()} is {@code 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.