public interface RaceConstrainerSmartPollsSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
polls. a RaceConstrainerQuery
can be retrieved from this
session and mapped to this Polls
to create a virtual
collection of race constrainers. The race constrainer may be sequenced
using the RaceConstrainerSearchOrder
from this session.
This Polls
has a default query that matches any race
constrainer and a default search order that specifies no sequencing. The
queries may be examined using a RaceConstrainerQueryInspector.
The query may be modified by converting the inspector back to a
RaceConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRaceConstrainerQuery(RaceConstrainerQuery raceConstrainerQuery)
Applies a race constrainer query to this polls.
|
void |
applyRaceConstrainerSequencing(RaceConstrainerSearchOrder raceConstrainerSearchOrder)
Applies a race constrainer 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. |
RaceConstrainerQuery |
getRaceConstrainerQuery()
Gets a race constrainer query.
|
RaceConstrainerQuery |
getRaceConstrainerQueryFromInspector(RaceConstrainerQueryInspector raceConstrainerQueryInspector)
Gets a race constrainer query from an inspector.
|
RaceConstrainerSearchOrder |
getRaceConstrainerSearchOrder()
Gets a race constrainer search order.
|
RaceConstrainerQueryInspector |
inspectRaceConstrainerQuery()
Gets a race constrainer 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.OperationFailedException
- 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. RaceConstrainerQuery getRaceConstrainerQuery()
mandatory
- This method must be implemented. RaceConstrainerSearchOrder getRaceConstrainerSearchOrder()
mandatory
- This method must be implemented. void applyRaceConstrainerQuery(RaceConstrainerQuery raceConstrainerQuery) throws OperationFailedException, PermissionDeniedException
raceConstrainerQuery
- the race constrainer queryNullArgumentException
- raceConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- raceConstrainerQuery
not of this servicemandatory
- This method must be implemented. RaceConstrainerQueryInspector inspectRaceConstrainerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRaceConstrainerSequencing(RaceConstrainerSearchOrder raceConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
raceConstrainerSearchOrder
- the race constrainer search orderNullArgumentException
-
raceConstrainerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
raceConstrainerSearchOrder
not of this servicemandatory
- This method must be implemented. RaceConstrainerQuery getRaceConstrainerQueryFromInspector(RaceConstrainerQueryInspector raceConstrainerQueryInspector)
raceConstrainerQueryInspector
- a race constrainer query
inspectorNullArgumentException
-
raceConstrainerQueryInspector
is null
UnsupportedException
-
raceConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.