public interface PlanSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CourseOfferingSearchOrder |
getCourseOfferingSearchOrder()
Gets the course offering order.
|
PlanSearchOrderRecord |
getPlanSearchOrderRecord(Type planRecordType)
Gets the plan search order record corresponding to the given plan
record
Type. |
SyllabusSearchOrder |
getSyllabusSearchOrder()
Gets the syllabus order.
|
void |
orderByCourseOffering(SearchOrderStyle style)
Specifies a preference for ordering the result set by the course
offering.
|
void |
orderBySyllabus(SearchOrderStyle style)
Specifies a preference for ordering the result set by the syllabus.
|
boolean |
supportsCourseOfferingSearchOrder()
Tests if a course offering order is available.
|
boolean |
supportsSyllabusSearchOrder()
Tests if a syllabus order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderBySyllabus(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSyllabusSearchOrder()
true
if a syllabus order is available,
false
otherwisemandatory
- This method must be implemented. SyllabusSearchOrder getSyllabusSearchOrder()
UnimplementedException
-
supportsSyllabusSearchOrder()
is false
optional
- This method must be implemented if
supportsCourseSearchOrder()
is true.
void orderByCourseOffering(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCourseOfferingSearchOrder()
true
if a course offering order is available,
false
otherwisemandatory
- This method must be implemented. CourseOfferingSearchOrder getCourseOfferingSearchOrder()
UnimplementedException
-
supportsCourseOfferingSearchOrder()
is false
optional
- This method must be implemented if
supportsCourseSearchOrder()
is true.
PlanSearchOrderRecord getPlanSearchOrderRecord(Type planRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.planRecordType
- a plan record typeNullArgumentException
- planRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(planRecordType)
is false
mandatory
- This method must be implemented.