public interface VoteQuerySession extends OsidSession
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.
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 |
---|---|
boolean |
canSearchVotes()
Tests if this user can perform
Vote searches. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
VoteQuery |
getVoteQuery()
Gets a vote query.
|
VoteList |
getVotesByQuery(VoteQuery voteQuery)
Gets a list of
Vote matching the given vote query. |
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 canSearchVotes()
Vote
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. VoteQuery getVoteQuery()
mandatory
- This method must be implemented. VoteList getVotesByQuery(VoteQuery voteQuery) throws OperationFailedException, PermissionDeniedException
Vote
matching the given vote query.voteQuery
- the vote query VoteList
NullArgumentException
- voteQuery is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- voteQuery
is not
of this servicemandatory
- This method must be implemented.