public interface RaceProcessorEnablerSmartPollsSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
polls. a RaceProcessorEnablerQuery
can be retrieved from
this session and mapped to this Polls
to create a virtual
collection of race processor enablers. The race processor enablers may be
sequenced using the RaceProcessorEnablerSearchOrder
from
this session.
This Polls
has a default query that matches any race
processor enabler and a default search order that specifies no sequencing.
The queries may be examined using a
RaceProcessorEnablerQueryInspector.
The query may be modified by
converting the inspector back to a RaceProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRaceProcessorEnablerQuery(RaceProcessorEnablerQuery raceProcessorEnablerQuery)
Applies a race processor enabler query to this polls.
|
void |
applyRaceProcessorEnablerSequencing(RaceProcessorEnablerSearchOrder raceProcessorEnablerSearchOrder)
Applies a race processor enabler 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. |
RaceProcessorEnablerQuery |
getRaceProcessorEnablerQuery()
Gets a race processor enabler query.
|
RaceProcessorEnablerQuery |
getRaceProcessorEnablerQueryFromInspector(RaceProcessorEnablerQueryInspector raceProcessorEnablerQueryInspector)
Gets a race processor enabler query from an inspector.
|
RaceProcessorEnablerSearchOrder |
getRaceProcessorEnablerSearchOrder()
Gets a race processor enabler search order.
|
RaceProcessorEnablerQueryInspector |
inspectRaceProcessorEnablerQuery()
Gets a race processor enabler 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. RaceProcessorEnablerQuery getRaceProcessorEnablerQuery()
mandatory
- This method must be implemented. RaceProcessorEnablerSearchOrder getRaceProcessorEnablerSearchOrder()
mandatory
- This method must be implemented. void applyRaceProcessorEnablerQuery(RaceProcessorEnablerQuery raceProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
raceProcessorEnablerQuery
- the race processor enabler queryNullArgumentException
-
raceProcessorEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- raceProcessorEnablerQuery
not of this servicemandatory
- This method must be implemented. RaceProcessorEnablerQueryInspector inspectRaceProcessorEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRaceProcessorEnablerSequencing(RaceProcessorEnablerSearchOrder raceProcessorEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
raceProcessorEnablerSearchOrder
- the race processor enabler
search orderNullArgumentException
-
raceProcessorEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
raceProcessorEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. RaceProcessorEnablerQuery getRaceProcessorEnablerQueryFromInspector(RaceProcessorEnablerQueryInspector raceProcessorEnablerQueryInspector)
raceProcessorEnablerQueryInspector
- a race processor enabler
query inspectorNullArgumentException
-
raceProcessorEnablerQueryInspector
is null
UnsupportedException
-
raceProcessorEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.