org.osid.course.syllabus

Interface ModuleSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, OsidSubjugateableSearchOrder, Suppliable

public interface ModuleSearchOrder
extends OsidGovernatorSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and 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 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.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

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 supportsCourseSearchOrder() is 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.