public interface LessonSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
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. |
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByPlan(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPlanSearchOrder()
PlanSearchOrder
is available. true
if a plan search order is available,
false
otherwisemandatory
- This method must be implemented. PlanSearchOrder getPlanSearchOrder()
UnimplementedException
-
supportsPlanSearchOrder()
is false
optional
- This method must be implemented if
supportsPlanSearchOrder()
is true.
void orderByDocet(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsDocetSearchOrder()
DocetSearchOrder
is available. true
if a docet search order is available,
false
otherwisemandatory
- This method must be implemented. DocetSearchOrder getDocetSearchOrder()
UnimplementedException
-
supportsDocetSearchOrder()
is false
optional
- This method must be implemented if
supportsDocetSearchOrder()
is true.
void orderByPlannedStartTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByBegun(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByActualStartTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByActualStartingActivity(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsActualStartingActivitySearchOrder()
ActivitySearchOrder
is available. true
if an activity search order is available,
false
otherwisemandatory
- This method must be implemented. ActivitySearchOrder getActualStartingActivitySearchOrder()
UnimplementedException
-
supportsActualStartingActivitySearchOrder()
is
false
optional
- This method must be implemented if
supportsActualStartingActivitySearchOrder()
is
true.
void orderByComplete(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySkipped(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByActualEndTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByActualEndingActivity(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsActualEndingActivitySearchOrder()
ActivitySearchOrder
is available. true
if an activity search order is available,
false
otherwisemandatory
- This method must be implemented. ActivitySearchOrder getActualEndingActivitySearchOrder()
UnimplementedException
-
supportsActualEndingActivitySearchOrder()
is
false
optional
- This method must be implemented if
supportsActualEndingActivitySearchOrder()
is
true.
void orderByActualTimeSpent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. LessonSearchOrderRecord getLessonSearchOrderRecord(Type lessonRecordType) throws OperationFailedException
lessonRecordType
- a lesson record typeNullArgumentException
- lessonRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(lessonRecordType)
is false
mandatory
- This method must be implemented.