public interface VoteSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CandidateSearchOrder |
getCandidateSearchOrder()
Gets the search order interface for a candidate.
|
ResourceSearchOrder |
getVoterSearchOrder()
Gets the search order for a resource.
|
VoteSearchOrderRecord |
getVoteSearchOrderRecord(Type voteRecordType)
Gets the vote search order record corresponding to the given vote
record
Type. |
AgentSearchOrder |
getVotingAgentSearchOrder()
Gets the search order for an agent.
|
void |
orderByCandidate(SearchOrderStyle style)
Specified a preference for ordering results by the candidate.
|
void |
orderByVoter(SearchOrderStyle style)
Specified a preference for ordering results by the voter.
|
void |
orderByVotes(SearchOrderStyle style)
Specified a preference for ordering results by the number of votes.
|
void |
orderByVotingAgent(SearchOrderStyle style)
Specified a preference for ordering results by the voteing agent.
|
boolean |
supportsCandidateSearchOrder()
Tests if a
CandidateSearchOrder is available. |
boolean |
supportsVoterSearchOrder()
Tests if a
ResourceSearchOrder is available. |
boolean |
supportsVotingAgentSearchOrder()
Tests if an
AgentSearchOrder is available. |
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByCandidate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCandidateSearchOrder()
CandidateSearchOrder
is available. true
if a candidate search order is available,
false
otherwisemandatory
- This method must be implemented. CandidateSearchOrder getCandidateSearchOrder()
UnimplementedException
-
supportsCandidateSearchOrder()
is false
optional
- This method must be implemented if
supportsCandidateSearchOrder()
is true.
void orderByVoter(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsVoterSearchOrder()
ResourceSearchOrder
is available. true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getVoterSearchOrder()
UnimplementedException
-
supportsVoterSearchOrder()
is false
optional
- This method must be implemented if
supportsVoterSearchOrder()
is true.
void orderByVotingAgent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsVotingAgentSearchOrder()
AgentSearchOrder
is available. true
if an agent search order is available,
false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getVotingAgentSearchOrder()
UnimplementedException
-
supportsVotingAgentSearchOrder()
is false
optional
- This method must be implemented if
supportsVotingAgentSearchOrder()
is true.
void orderByVotes(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. VoteSearchOrderRecord getVoteSearchOrderRecord(Type voteRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.voteRecordType
- a vote record typeNullArgumentException
- voteRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(VoteRecordType)
is false
mandatory
- This method must be implemented.