org.osid.voting.rules

Interface RaceProcessorEnablerSmartPollsSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPollsId

Id getPollsId()

Gets the Polls Id associated with this session.

Returns:

the Polls Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPolls

Polls getPolls()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Polls associated with this session.

Returns:

the polls

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartPolls

boolean canManageSmartPolls()

Tests if this user can manage smart polls. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart polls management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRaceProcessorEnablerQuery

RaceProcessorEnablerQuery getRaceProcessorEnablerQuery()

Gets a race processor enabler query.

Returns:

the race processor enabler query

Compliance:

mandatory - This method must be implemented.

getRaceProcessorEnablerSearchOrder

RaceProcessorEnablerSearchOrder getRaceProcessorEnablerSearchOrder()

Gets a race processor enabler search order.

Returns:

the race processor enabler search order

Compliance:

mandatory - This method must be implemented.

applyRaceProcessorEnablerQuery

void applyRaceProcessorEnablerQuery(RaceProcessorEnablerQuery raceProcessorEnablerQuery)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Applies a race processor enabler query to this polls.

Parameters:

raceProcessorEnablerQuery - the race processor enabler query

Throws:

NullArgumentException - raceProcessorEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - raceProcessorEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRaceProcessorEnablerQuery

RaceProcessorEnablerQueryInspector inspectRaceProcessorEnablerQuery()
                                                                    throws OperationFailedException,
                                                                           PermissionDeniedException

Gets a race processor enabler query inspector for this polls.

Returns:

the race processor enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRaceProcessorEnablerSequencing

void applyRaceProcessorEnablerSequencing(RaceProcessorEnablerSearchOrder raceProcessorEnablerSearchOrder)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Applies a race processor enabler search order to this polls.

Parameters:

raceProcessorEnablerSearchOrder - the race processor enabler search order

Throws:

NullArgumentException - raceProcessorEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - raceProcessorEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRaceProcessorEnablerQueryFromInspector

RaceProcessorEnablerQuery getRaceProcessorEnablerQueryFromInspector(RaceProcessorEnablerQueryInspector raceProcessorEnablerQueryInspector)

Gets a race processor enabler query from an inspector.

Parameters:

raceProcessorEnablerQueryInspector - a race processor enabler query inspector

Returns:

the race processor enabler query

Throws:

NullArgumentException - raceProcessorEnablerQueryInspector is null

UnsupportedException - raceProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.