public interface RaceConstrainerEnablerSmartPollsSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
polls. a RaceConstrainerEnablerQuery
can be retrieved from
this session and mapped to this Polls
to create a virtual
collection of race constrainer enablers. The race constrainer enablers may
be sequenced using the RaceConstrainerEnablerSearchOrder
from this session.
This Polls
has a default query that matches any race
constrainer enabler and a default search order that specifies no
sequencing. The queries may be examined using a
RaceConstrainerEnablerQueryInspector.
The query may be modified by
converting the inspector back to a RaceConstrainerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRaceConstrainerEnablerQuery(RaceConstrainerEnablerQuery raceConstrainerEnablerQuery)
Applies a race constrainer enabler query to this polls.
|
void |
applyRaceConstrainerEnablerSequencing(RaceConstrainerEnablerSearchOrder raceConstrainerEnablerSearchOrder)
Applies a race constrainer 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. |
RaceConstrainerEnablerQuery |
getRaceConstrainerEnablerQuery()
Gets a race constrainer enabler query.
|
RaceConstrainerEnablerQuery |
getRaceConstrainerEnablerQueryFromInspector(RaceConstrainerEnablerQueryInspector raceConstrainerEnablerQueryInspector)
Gets a race constrainer enabler query from an inspector.
|
RaceConstrainerEnablerSearchOrder |
getRaceConstrainerEnablerSearchOrder()
Gets a race constrainer enabler search order.
|
RaceConstrainerEnablerQueryInspector |
inspectRaceConstrainerEnablerQuery()
Gets a race constrainer 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. RaceConstrainerEnablerQuery getRaceConstrainerEnablerQuery()
mandatory
- This method must be implemented. RaceConstrainerEnablerSearchOrder getRaceConstrainerEnablerSearchOrder()
mandatory
- This method must be implemented. void applyRaceConstrainerEnablerQuery(RaceConstrainerEnablerQuery raceConstrainerEnablerQuery) throws OperationFailedException, PermissionDeniedException
raceConstrainerEnablerQuery
- the race constrainer enabler queryNullArgumentException
-
raceConstrainerEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
raceConstrainerEnablerQuery
not of this servicemandatory
- This method must be implemented. RaceConstrainerEnablerQueryInspector inspectRaceConstrainerEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRaceConstrainerEnablerSequencing(RaceConstrainerEnablerSearchOrder raceConstrainerEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
raceConstrainerEnablerSearchOrder
- the race constrainer enabler
search orderNullArgumentException
-
raceConstrainerEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
raceConstrainerEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. RaceConstrainerEnablerQuery getRaceConstrainerEnablerQueryFromInspector(RaceConstrainerEnablerQueryInspector raceConstrainerEnablerQueryInspector)
raceConstrainerEnablerQueryInspector
- a race constrainer
enabler query inspectorNullArgumentException
-
raceConstrainerEnablerQueryInspector
is null
UnsupportedException
-
raceConstrainerEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.