public interface ActivitySearchOrder extends OsidObjectSearchOrder, OsidFederateableSearchOrder, OsidTemporalSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ActivitySearchOrderRecord |
getActivitySearchOrderRecord(Type activityRecordType)
Gets the activity search order record corresponding to the given
activity record
Type. |
ResourceSearchOrder |
getOrganizationSearchOrder()
Gets the resource search order.
|
ResourceSearchOrder |
getSupervisorSearchOrder()
Gets the resource search order.
|
void |
orderByCode(SearchOrderStyle style)
Specifies a preference for ordering the result set by the code.
|
void |
orderByOrganization(SearchOrderStyle style)
Specifies a preference for ordering the result set by the
organization.
|
void |
orderBySupervisor(SearchOrderStyle style)
Specifies a preference for ordering the result set by the supervisor.
|
boolean |
supportsOrganizationSearchOrder()
Tests if a
ResourceSearchOrder is available. |
boolean |
supportsSupervisorSearchOrder()
Tests if a
ResourceSearchOrder is available. |
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByOrganization(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsOrganizationSearchOrder()
ResourceSearchOrder
is available. true
if a resource search order is available,
false
otherwiseNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ResourceSearchOrder getOrganizationSearchOrder()
UnimplementedException
-
supportsOrganizationSearchOrder()
is false
optional
- This method must be implemented if
supportsOrganizationSearchOrder()
is true.
void orderBySupervisor(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSupervisorSearchOrder()
ResourceSearchOrder
is available. true
if a resource search order is available,
false
otherwiseNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ResourceSearchOrder getSupervisorSearchOrder()
UnimplementedException
-
supportsSupervisorSearchOrder()
is false
optional
- This method must be implemented if
supportsSupervisorSearchOrder()
is true.
void orderByCode(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ActivitySearchOrderRecord getActivitySearchOrderRecord(Type activityRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.activityRecordType
- an activity record typeNullArgumentException
- activityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityRecordType)
is false
mandatory
- This method must be implemented.