public interface CandidateSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CandidateSearchOrderRecord |
getCandidateSearchOrderRecord(Type candidateRecordType)
Gets the candidate search order record corresponding to the given
candidate record
Type. |
RaceSearchOrder |
getRaceSearchOrder()
Gets the search order for a race.
|
ResourceSearchOrder |
getResourceSearchOrder()
Gets the search order for the associated resource.
|
void |
orderByRace(SearchOrderStyle style)
Specified a preference for ordering results by the race.
|
void |
orderByResource(SearchOrderStyle style)
Specified a preference for ordering results by the assoicated
resource.
|
boolean |
supportsRaceSearchOrder()
Tests if a
RaceSearchOrder is available. |
boolean |
supportsResourceSearchOrder()
Tests if a
ResourceSearchOrder is available. |
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByRace(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsRaceSearchOrder()
RaceSearchOrder
is available. true
if a race search order is available,
false
otherwisemandatory
- This method must be implemented. RaceSearchOrder getRaceSearchOrder()
UnimplementedException
-
supportsRaceSearchOrder()
is false
optional
- This method must be implemented if
supportsRaceSearchOrder()
is true.
void orderByResource(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsResourceSearchOrder()
ResourceSearchOrder
is available. true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getResourceSearchOrder()
UnimplementedException
-
supportsResourceSearchOrder()
is false
optional
- This method must be implemented if
supportsResourceSearchOrder()
is true.
CandidateSearchOrderRecord getCandidateSearchOrderRecord(Type candidateRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.candidateRecordType
- a candidate record typeNullArgumentException
- candidateRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(candidateRecordType)
is false
mandatory
- This method must be implemented.