public interface BallotConstrainerQuerySession extends OsidSession
This session provides methods for searching among
BallotConstrainer
objects. The search query is constructed using
the BallotConstrainerQuery.
This session defines views that offer differing behaviors for searching.
Ballot constrainer 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 |
---|---|
boolean |
canSearchBallotConstrainers()
Tests if this user can perform
BallotConstrainer
lookups. |
BallotConstrainerQuery |
getBallotConstrainerQuery()
Gets a ballot constrainer query.
|
BallotConstrainerList |
getBallotConstrainersByQuery(BallotConstrainerQuery ballotConstrainerQuery)
Gets a list of
BallotConstrainers matching the given
ballot constrainer query. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
void |
useFederatedPollsView()
Federates the view for methods in this session.
|
void |
useIsolatedPollsView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPollsId()
Polls
Id
associated with this
session. Polls Id
associated with this sessionmandatory
- This method must be implemented. Polls getPolls() throws OperationFailedException, PermissionDeniedException
Polls
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchBallotConstrainers()
BallotConstrainer
lookups. A return of true does not guarantee successful authorization.
A return of false indicates that it is known all methods in this
session will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may not offer lookup
operations to unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedPollsView()
mandatory
- This method is must be implemented. void useIsolatedPollsView()
mandatory
- This method is must be implemented. BallotConstrainerQuery getBallotConstrainerQuery()
mandatory
- This method must be implemented. BallotConstrainerList getBallotConstrainersByQuery(BallotConstrainerQuery ballotConstrainerQuery) throws OperationFailedException, PermissionDeniedException
BallotConstrainers
matching the given
ballot constrainer query.ballotConstrainerQuery
- the ballot constrainer query BallotConstrainerList
NullArgumentException
- ballotConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- ballotConstrainerQuery
is not of this servicemandatory
- This method must be implemented.