public interface PollsQuerySession extends OsidSession
This session provides methods for searching among Polls
objects. The search query is constructed using the PollsQuery.
Polls may have a polls query record indicated by their respective
record types. The polls query record is accessed via the
PollsQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchPolls()
Tests if this user can perform
Polls searches. |
PollsList |
getPollsByQuery(PollsQuery pollsQuery)
Gets a list of
Polls matching the given query. |
PollsQuery |
getPollsQuery()
Gets a polls query.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchPolls()
Polls
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. PollsQuery getPollsQuery()
mandatory
- This method must be implemented. PollsList getPollsByQuery(PollsQuery pollsQuery) throws OperationFailedException, PermissionDeniedException
Polls
matching the given query.pollsQuery
- the polls query PollsList
NullArgumentException
- pollsQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- a pollsQuery
is
not of this servicemandatory
- This method must be implemented.