public interface BallotQuerySession extends OsidSession
This session provides methods for searching among Ballot
objects. The search query is constructed using the BallotQuery.
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 |
---|---|
boolean |
canSearchBallots()
Tests if this user can perform
Ballot searches. |
BallotQuery |
getBallotQuery()
Gets a ballot query.
|
BallotList |
getBallotsByQuery(BallotQuery ballotQuery)
Gets a list of
Ballots matching the given 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. Polls
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchBallots()
Ballot
searches. 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 opt not to offer search 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. BallotQuery getBallotQuery()
mandatory
- This method must be implemented. BallotList getBallotsByQuery(BallotQuery ballotQuery) throws OperationFailedException, PermissionDeniedException
Ballots
matching the given query.ballotQuery
- the ballot query BallotList
NullArgumentException
- ballotQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- ballotQuery
is
not of this servicemandatory
- This method must be implemented.