public interface VoteSearch extends OsidSearch
VoteSearch
defines the interface for specifying vote
search options.
Modifier and Type | Method and Description |
---|---|
VoteSearchRecord |
getVoteSearchRecord(Type voteSearchRecordType)
Gets the vote search record corresponding to the given vote search
record
Type. |
void |
orderVoteResults(VoteSearchOrder voteSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongVotes(IdList voteIds)
Execute this search among the given list of votes.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongVotes(IdList voteIds)
voteIds
- a list of vote Ids
NullArgumentException
- voteIds
is
null
mandatory
- This method must be implemented. void orderVoteResults(VoteSearchOrder voteSearchOrder)
voteSearchOrder
- a vote search orderNullArgumentException
- voteSearchOrder
is null
UnsupportedException
- voteSearchOrder
is not of this servicemandatory
- This method must be implemented. VoteSearchRecord getVoteSearchRecord(Type voteSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to retrieve an object
implementing the requested record.voteSearchRecordType
- a vote search record typeNullArgumentException
- voteSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(voteSearchRecordType)
is false
mandatory
- This method must be implemented.