public interface ActivityRegistrationSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ActivityRegistrationSearchOrderRecord |
getActivityRegistrationSearchOrderRecord(Type activityRegistrationRecordType)
Gets the activity registration search order record corresponding to
the given activity registration record
Type. |
ActivitySearchOrder |
getActivitySearchOrder()
Gets the activity search order.
|
RegistrationSearchOrder |
getRegistrationSearchOrder()
Gets the registration search order.
|
ResourceSearchOrder |
getStudentSearchOrder()
Gets the student search order.
|
void |
orderByActivity(SearchOrderStyle style)
Specifies a preference for ordering the result set by activity.
|
void |
orderByRegistration(SearchOrderStyle style)
Specifies a preference for ordering the result set by registration.
|
void |
orderByStudent(SearchOrderStyle style)
Specifies a preference for ordering the result set by student.
|
boolean |
supportsActivitySearchOrder()
Tests if an activity search order is available.
|
boolean |
supportsRegistrationSearchOrder()
Tests if a regiistration 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 orderByRegistration(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsRegistrationSearchOrder()
true
if a registration search order is
available, false
otherwisemandatory
- This method must be implemented. RegistrationSearchOrder getRegistrationSearchOrder()
UnimplementedException
-
supportsRegistrationSearchOrder()
is false
optional
- This method must be implemented if
supportsRegistrationSearchOrder()
is true.
void orderByActivity(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsActivitySearchOrder()
true
if an activity search order is available,
false
otherwisemandatory
- This method must be implemented. ActivitySearchOrder getActivitySearchOrder()
UnimplementedException
-
supportsActivitySearchOrder()
is false
optional
- This method must be implemented if
supportsActivitySearchOrder()
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.
ActivityRegistrationSearchOrderRecord getActivityRegistrationSearchOrderRecord(Type activityRegistrationRecordType) throws OperationFailedException
Type.
Multiple
retrievals return the same underlying object.activityRegistrationRecordType
- an activity registration record
typeNullArgumentException
-
activityRegistrationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityRegistrationRecordType)
is
false
mandatory
- This method must be implemented.