public interface VoteSearchSession extends VoteQuerySession
This session provides methods for searching Vote
objects. The search query is constructed using the VoteQuery.
The vote record Type
also specifies the record for
the vote query.
getVotesByQuery()
is the basic search method and
returns a list of Votes.
A more advanced search may be
performed with getVotesBySearch().
It accepts a
VoteSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getVotesBySearch()
returns an VoteSearchResults
that can be used to access the resulting VoteList
or be
used to perform a search within the result set through VoteSearch.
This session defines views that offer differing behaviors for searching.
Votes may have a query record indicated by their respective record
types. The query record is accessed via the VoteQuery.
Modifier and Type | Method and Description |
---|---|
VoteQuery |
getVoteQueryFromInspector(VoteQueryInspector voteQueryInspector)
Gets a vote query from an inspector.
|
VoteSearchResults |
getVotesBySearch(VoteQuery voteQuery,
VoteSearch voteSearch)
Gets the search results matching the given search query using the
given search.
|
VoteSearch |
getVoteSearch()
Gets a vote search.
|
VoteSearchOrder |
getVoteSearchOrder()
Gets a vote search order.
|
canSearchVotes, getPolls, getPollsId, getVoteQuery, getVotesByQuery, useFederatedPollsView, useIsolatedPollsView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
VoteSearch getVoteSearch()
mandatory
- This method must be implemented. VoteSearchOrder getVoteSearchOrder()
VoteSearchOrder
is
supplied to a VoteSearch
to specify the ordering of
results.mandatory
- This method must be implemented. VoteSearchResults getVotesBySearch(VoteQuery voteQuery, VoteSearch voteSearch) throws OperationFailedException, PermissionDeniedException
voteQuery
- the vote search queryvoteSearch
- the vote searchNullArgumentException
- voteQuery
or
voteSearch is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- voteSearch
or
voteQuery is not of this servicemandatory
- This method must be implemented. VoteQuery getVoteQueryFromInspector(VoteQueryInspector voteQueryInspector)
VoteSearchResults.
voteQueryInspector
- a vote query inspectorNullArgumentException
- voteQueryInspector
is null
UnsupportedException
- voteQueryInspector
is not of this servicemandatory
- This method must be implemented.