public interface BallotSmartPollsSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A BallotQuery
can be retrieved from this session
and mapped to this Polls
to create a virtual collection of
Ballots.
The ballots may be sequenced using the
BallotSearchOrder
from this session.
This Polls
has a default query that matches any ballot
and a default search order that specifies no sequencing. The queries may
be examined using a BallotQueryInspector.
The query may be
modified by converting the inspector back to a BallotQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyBallotQuery(BallotQuery ballotQuery)
Applies a ballot query to this polls.
|
void |
applyBallotSequencing(BallotSearchOrder ballotSearchOrder)
Applies a ballot search order to this polls.
|
boolean |
canManageSmartPolls()
Tests if this user can manage smart polls.
|
BallotQuery |
getBallotQuery()
Gets a ballot query.
|
BallotQuery |
getBallotQueryFromInspector(BallotQueryInspector ballotQueryInspector)
Gets a ballot query from an inspector.
|
BallotSearchOrder |
getBallotSearchOrder()
Gets a ballot search order.
|
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
BallotQueryInspector |
inspectBallotQuery()
Gets a ballot 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. BallotQuery getBallotQuery()
mandatory
- This method must be implemented. BallotSearchOrder getBallotSearchOrder()
mandatory
- This method must be implemented. void applyBallotQuery(BallotQuery ballotQuery) throws OperationFailedException, PermissionDeniedException
ballotQuery
- the ballot queryNullArgumentException
- ballotQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- ballotQuery
not
of this servicemandatory
- This method must be implemented. BallotQueryInspector inspectBallotQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyBallotSequencing(BallotSearchOrder ballotSearchOrder) throws OperationFailedException, PermissionDeniedException
ballotSearchOrder
- the ballot search orderNullArgumentException
- ballotSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- ballotSearchOrder
not of this servicemandatory
- This method must be implemented. BallotQuery getBallotQueryFromInspector(BallotQueryInspector ballotQueryInspector)
ballotQueryInspector
- a ballot query inspectorNullArgumentException
- ballotQueryInspector
is null
UnsupportedException
- ballotQueryInspector
is not of this servicemandatory
- This method must be implemented.