public interface BallotConstrainerSearchSession extends BallotConstrainerQuerySession
This session provides methods for searching among
BallotConstrainer
objects. The search query is constructed using
the BallotConstraineryQuery.
getBallotConstrainersByQuery()
is the basic search
method and returns a list of BallotConstrainers.
A more
advanced search may be performed with
getBallotConstrainersBySearch().
It accepts a
BallotConstrainerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
voting. getBallotConstrainersBySearch()
returns a
BallotConstrainerSearchResults
that can be used to access the
resulting BallotConstrainerList
or be used to perform a
search within the result set through BallotConstrainerSearch.
This session defines views that offer differing behaviors for searching.
BallotConstrainers
may have a query record indicated by
their respective record types. The query record is accessed via the
BallotConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
BallotConstrainerQuery |
getBallotConstrainerQueryFromInspector(BallotConstrainerQueryInspector ballotConstrainerQueryInspector)
Gets a ballot constrainer query from an inspector.
|
BallotConstrainerSearchResults |
getBallotConstrainersBySearch(BallotConstrainerQuery ballotConstrainerQuery,
BallotConstrainerSearch ballotConstrainerSearch)
Gets the search results matching the given search query using the
given search.
|
BallotConstrainerSearch |
getBallotConstrainerSearch()
Gets a ballot constrainer search.
|
BallotConstrainerSearchOrder |
getBallotConstrainerSearchOrder()
Gets a ballot constrainer search order.
|
canSearchBallotConstrainers, getBallotConstrainerQuery, getBallotConstrainersByQuery, getPolls, getPollsId, useFederatedPollsView, useIsolatedPollsView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BallotConstrainerSearch getBallotConstrainerSearch()
mandatory
- This method must be implemented. BallotConstrainerSearchOrder getBallotConstrainerSearchOrder()
BallotConstrainerSearchOrder
is supplied to a
BallotConstrainerSearch
to specify the ordering of results.mandatory
- This method must be implemented. BallotConstrainerSearchResults getBallotConstrainersBySearch(BallotConstrainerQuery ballotConstrainerQuery, BallotConstrainerSearch ballotConstrainerSearch) throws OperationFailedException, PermissionDeniedException
ballotConstrainerQuery
- the ballot constrainer queryballotConstrainerSearch
- the ballot constrainer searchNullArgumentException
- ballotConstrainerQuery
or ballotConstrainerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- ballotConstrainerQuery
or ballotConstrainerSearch
is not of
this servicemandatory
- This method must be implemented. BallotConstrainerQuery getBallotConstrainerQueryFromInspector(BallotConstrainerQueryInspector ballotConstrainerQueryInspector)
BallotConstrainerSearchResults.
ballotConstrainerQueryInspector
- a ballot constrainer query
inspectorNullArgumentException
-
ballotConstrainerQueryInspector
is null
UnsupportedException
-
ballotConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.