public interface ActivityBundleSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ActivityBundleSearchOrderRecord |
getActivityBundleSearchOrderRecord(Type activityBundleRecordType)
Gets the activity bundle search order record corresponding to the
given activity bundle record
Type. |
CourseOfferingSearchOrder |
getCourseOfferingSearchOrder()
Gets the course offering order.
|
void |
orderByCourseOffering(SearchOrderStyle style)
Specifies a preference for ordering the result set by course offering.
|
boolean |
supportsCourseOfferingSearchOrder()
Tests if a course offering order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByCourseOffering(SearchOrderStyle style)
style
- a 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.
ActivityBundleSearchOrderRecord getActivityBundleSearchOrderRecord(Type activityBundleRecordType) throws OperationFailedException
Type.
Multiple retrievals
return the same underlying object.activityBundleRecordType
- an activity bundle record typeNullArgumentException
- activityBundleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityBundleRecordType)
is
false
mandatory
- This method must be implemented.