org.osid.course.plan

Interface LessonSearchOrder

All Superinterfaces:

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

public interface LessonSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ActivitySearchOrder	getActualEndingActivitySearchOrder() Gets the search order for an actual ending actvity.
ActivitySearchOrder	getActualStartingActivitySearchOrder() Gets the search order for an actual starting actvity.
DocetSearchOrder	getDocetSearchOrder() Gets the search order for a docet.
LessonSearchOrderRecord	getLessonSearchOrderRecord(Type lessonRecordType) Gets the lesson search order record corresponding to the given lesson record Type.
PlanSearchOrder	getPlanSearchOrder() Gets the search order for a plan.
void	orderByActualEndingActivity(SearchOrderStyle style) Specified a preference for ordering results by the actual ending activity.
void	orderByActualEndTime(SearchOrderStyle style) Specified a preference for ordering results by the actual end time.
void	orderByActualStartingActivity(SearchOrderStyle style) Specified a preference for ordering results by the actual starting activity.
void	orderByActualStartTime(SearchOrderStyle style) Specified a preference for ordering results by the actual start time.
void	orderByActualTimeSpent(SearchOrderStyle style) Specified a preference for ordering results by the actual time spent.
void	orderByBegun(SearchOrderStyle style) Specified a preference for ordering results by the begun flag.
void	orderByComplete(SearchOrderStyle style) Specified a preference for ordering results by the complete flag.
void	orderByDocet(SearchOrderStyle style) Specified a preference for ordering results by the docet.
void	orderByPlan(SearchOrderStyle style) Specified a preference for ordering results by the plan.
void	orderByPlannedStartTime(SearchOrderStyle style) Specified a preference for ordering results by the planned start time.
void	orderBySkipped(SearchOrderStyle style) Specified a preference for ordering results by the skipped flag.
boolean	supportsActualEndingActivitySearchOrder() Tests if an ActivitySearchOrder is available.
boolean	supportsActualStartingActivitySearchOrder() Tests if an ActivitySearchOrder is available.
boolean	supportsDocetSearchOrder() Tests if a DocetSearchOrder is available.
boolean	supportsPlanSearchOrder() Tests if a PlanSearchOrder 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

orderByPlan

void orderByPlan(SearchOrderStyle style)

Specified a preference for ordering results by the plan.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsPlanSearchOrder

boolean supportsPlanSearchOrder()

Tests if a PlanSearchOrder is available.

Returns:

true if a plan search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPlanSearchOrder

PlanSearchOrder getPlanSearchOrder()

Gets the search order for a plan.

Returns:

the plan search order

Throws:

UnimplementedException - supportsPlanSearchOrder() is false

Compliance:

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

orderByDocet

void orderByDocet(SearchOrderStyle style)

Specified a preference for ordering results by the docet.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsDocetSearchOrder

boolean supportsDocetSearchOrder()

Tests if a DocetSearchOrder is available.

Returns:

true if a docet search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDocetSearchOrder

DocetSearchOrder getDocetSearchOrder()

Gets the search order for a docet.

Returns:

the docet search order

Throws:

UnimplementedException - supportsDocetSearchOrder() is false

Compliance:

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

orderByPlannedStartTime

void orderByPlannedStartTime(SearchOrderStyle style)

Specified a preference for ordering results by the planned start time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByBegun

void orderByBegun(SearchOrderStyle style)

Specified a preference for ordering results by the begun flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByActualStartTime

void orderByActualStartTime(SearchOrderStyle style)

Specified a preference for ordering results by the actual start time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByActualStartingActivity

void orderByActualStartingActivity(SearchOrderStyle style)

Specified a preference for ordering results by the actual starting activity.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsActualStartingActivitySearchOrder

boolean supportsActualStartingActivitySearchOrder()

Tests if an ActivitySearchOrder is available.

Returns:

true if an activity search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActualStartingActivitySearchOrder

ActivitySearchOrder getActualStartingActivitySearchOrder()

Gets the search order for an actual starting actvity.

Returns:

the activity search order

Throws:

UnimplementedException - supportsActualStartingActivitySearchOrder() is false

Compliance:

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

orderByComplete

void orderByComplete(SearchOrderStyle style)

Specified a preference for ordering results by the complete flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySkipped

void orderBySkipped(SearchOrderStyle style)

Specified a preference for ordering results by the skipped flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByActualEndTime

void orderByActualEndTime(SearchOrderStyle style)

Specified a preference for ordering results by the actual end time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByActualEndingActivity

void orderByActualEndingActivity(SearchOrderStyle style)

Specified a preference for ordering results by the actual ending activity.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsActualEndingActivitySearchOrder

boolean supportsActualEndingActivitySearchOrder()

Tests if an ActivitySearchOrder is available.

Returns:

true if an activity search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActualEndingActivitySearchOrder

ActivitySearchOrder getActualEndingActivitySearchOrder()

Gets the search order for an actual ending actvity.

Returns:

the activity search order

Throws:

UnimplementedException - supportsActualEndingActivitySearchOrder() is false

Compliance:

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

orderByActualTimeSpent

void orderByActualTimeSpent(SearchOrderStyle style)

Specified a preference for ordering results by the actual time spent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getLessonSearchOrderRecord

LessonSearchOrderRecord getLessonSearchOrderRecord(Type lessonRecordType)
                                                   throws OperationFailedException

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

Parameters:

lessonRecordType - a lesson record type

Returns:

the lesson search order record

Throws:

NullArgumentException - lessonRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(lessonRecordType) is false

Compliance:

mandatory - This method must be implemented.