public interface BallotSearchSession extends BallotQuerySession
This session provides methods for searching among Ballot
objects. The search query is constructed using the BallotQuery.
getBallotsByQuery()
is the basic search method and
returns a list of Ballots.
A more advanced search may be
performed with getBallotsBySearch().
It accepts an
BallotSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getBallotsBySearch()
returns an
BallotSearchResults
that can be used to access the resulting
BallotList
or be used to perform a search within the result
set through BallotList.
This session defines views that offer differing behaviors for searching.
Ballots may have a ballot query record indicated by their respective
record types. The ballot query record is accessed via the
BallotQuery.
Modifier and Type | Method and Description |
---|---|
BallotQuery |
getBallotQueryFromInspector(BallotQueryInspector ballotQueryInspector)
Gets a ballot query from an inspector.
|
BallotSearchResults |
getBallotsBySearch(BallotQuery ballotQuery,
BallotSearch ballotSearch)
Gets the search results matching the given search query using the
given search.
|
BallotSearch |
getBallotSearch()
Gets a ballot search.
|
BallotSearchOrder |
getBallotSearchOrder()
Gets a ballot search order.
|
canSearchBallots, getBallotQuery, getBallotsByQuery, getPolls, getPollsId, useFederatedPollsView, useIsolatedPollsView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BallotSearch getBallotSearch()
mandatory
- This method must be implemented. BallotSearchOrder getBallotSearchOrder()
BallotSearchOrder
is
supplied to a BallotSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BallotSearchResults getBallotsBySearch(BallotQuery ballotQuery, BallotSearch ballotSearch) throws OperationFailedException, PermissionDeniedException
ballotQuery
- the ballot queryballotSearch
- the ballot searchNullArgumentException
- ballotQuery
or
ballotSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- ballotQuery
or
ballotSearch
is not of this servicemandatory
- This method must be implemented. BallotQuery getBallotQueryFromInspector(BallotQueryInspector ballotQueryInspector)
BallotSearchResults.
ballotQueryInspector
- a ballot query inspectorNullArgumentException
- ballotQueryInspector
is null
UnsupportedException
- ballotQueryInspector
is not of this servicemandatory
- This method must be implemented.