Interface ModuleSearchOrder

All Superinterfaces:

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

public interface ModuleSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
ModuleSearchOrderRecord	getModuleSearchOrderRecord(Type moduleRecordType)	Gets the module search order record corresponding to the given module record Type .
SyllabusSearchOrder	getSyllabusSearchOrder()	Gets the syllabus order.
void	orderBySyllabus(SearchOrderStyle style)	Specifies a preference for ordering the result set by the syllabus.
boolean	supportsSyllabusSearchOrder()	Tests if a syllabus 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

orderBySyllabus

void orderBySyllabus(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSyllabusSearchOrder

boolean supportsSyllabusSearchOrder()

Tests if a syllabus order is available.

Returns:

true if a syllabus order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSyllabusSearchOrder

SyllabusSearchOrder getSyllabusSearchOrder()

Gets the syllabus order.

Returns:

the syllabus search order

Throws:

UnimplementedException - supportsSyllabusSearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseSearchOrder()} is {@code true} .

getModuleSearchOrderRecord

ModuleSearchOrderRecord getModuleSearchOrderRecord(Type moduleRecordType)
                                            throws OperationFailedException

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

Parameters:

moduleRecordType - a module record type

Returns:

the module search order record

Throws:

NullArgumentException - moduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(moduleRecordType) is false

Compliance:

mandatory - This method must be implemented.