public interface VoteSmartPollsSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A VoteQuery
can be retrieved from this session
and mapped to this Polls
to create a virtual collection of
Votes.
The votes may be sequenced using the
VoteSearchOrder
from this session.
This Polls
has a default query that matches any vote
and a default search order that specifies no sequencing. The queries may
be examined using a VoteQueryInspector.
The query may be
modified by converting the inspector back to a VoteQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyVoteQuery(VoteQuery voteQuery)
Applies a vote query to this polls.
|
void |
applyVoteSequencing(VoteSearchOrder voteSearchOrder)
Applies a vote search order to this polls.
|
boolean |
canManageSmartPolls()
Tests if this user can manage smart polls.
|
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.
|
VoteQuery |
getVoteQueryFromInspector(VoteQueryInspector voteQueryInspector)
Gets a vote query from an inspector.
|
VoteSearchOrder |
getVoteSearchOrder()
Gets a vote search order.
|
VoteQueryInspector |
inspectVoteQuery()
Gets a vote query inspector for this polls.
|
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 canManageSmartPolls()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart polls management is not
authorized, true
otherwisemandatory
- This method must be implemented. VoteQuery getVoteQuery()
mandatory
- This method must be implemented. VoteSearchOrder getVoteSearchOrder()
mandatory
- This method must be implemented. void applyVoteQuery(VoteQuery voteQuery) throws OperationFailedException, PermissionDeniedException
voteQuery
- the vote queryNullArgumentException
- voteQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- voteQuery
not of
this servicemandatory
- This method must be implemented. VoteQueryInspector inspectVoteQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyVoteSequencing(VoteSearchOrder voteSearchOrder) throws OperationFailedException, PermissionDeniedException
voteSearchOrder
- the vote search orderNullArgumentException
- voteSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- voteSearchOrder
not of this servicemandatory
- This method must be implemented. VoteQuery getVoteQueryFromInspector(VoteQueryInspector voteQueryInspector)
voteQueryInspector
- a vote query inspectorNullArgumentException
- voteQueryInspector
is null
UnsupportedException
- voteQueryInspector
is not of this servicemandatory
- This method must be implemented.