public interface RegistrationSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ActivityBundleSearchOrder |
getActivityBundleSearchOrder()
Gets the activity bundle search order.
|
GradeSystemSearchOrder |
getGradingOptionSearchOrder()
Gets the grade system search order.
|
RegistrationSearchOrderRecord |
getRegistrationSearchOrderRecord(Type registrationRecordType)
Gets the registration search order record corresponding to the given
registration record
Type. |
ResourceSearchOrder |
getStudentSearchOrder()
Gets the student search order.
|
void |
orderByActivityBundle(SearchOrderStyle style)
Specifies a preference for ordering the result set by activity bundle.
|
void |
orderByGradingOption(SearchOrderStyle style)
Specifies a preference for ordering the result set by the grading
option.
|
void |
orderByStudent(SearchOrderStyle style)
Specifies a preference for ordering the result set by student.
|
boolean |
supportsActivityBundleSearchOrder()
Tests if an activity bundle search order is available.
|
boolean |
supportsGradingOptionSearchOrder()
Tests if a grade system search order is available.
|
boolean |
supportsStudentSearchOrder()
Tests if a student search order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByActivityBundle(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsActivityBundleSearchOrder()
true
if an activity bundle search order is
available, false
otherwisemandatory
- This method must be implemented. ActivityBundleSearchOrder getActivityBundleSearchOrder()
UnimplementedException
-
supportsActivityBundleSearchOrder()
is false
optional
- This method must be implemented if
supportsActivityBundleSearchOrder()
is
true.
void orderByStudent(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsStudentSearchOrder()
true
if a student search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getStudentSearchOrder()
UnimplementedException
-
supportsStudentSearchOrder()
is false
optional
- This method must be implemented if
supportsStudentSearchOrder()
is true.
void orderByGradingOption(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsGradingOptionSearchOrder()
true
if a grade system order is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemSearchOrder getGradingOptionSearchOrder()
UnimplementedException
-
supportsGradingOptionSearchOrder()
is false
optional
- This method must be implemented if
supportsGradingOptionSearchOrder()
is true.
RegistrationSearchOrderRecord getRegistrationSearchOrderRecord(Type registrationRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.registrationRecordType
- a registration record typeNullArgumentException
- registrationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(registrationRecordType)
is false
mandatory
- This method must be implemented.