org.osid.voting.rules

Interface RaceProcessorSmartPollsSession

All Superinterfaces:

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

public interface RaceProcessorSmartPollsSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic polls. a RaceProcessorQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of race processors. The race processor may be sequenced using the RaceProcessorSearchOrder from this session.

This Polls has a default query that matches any race processor and a default search order that specifies no sequencing. The queries may be examined using a RaceProcessorQueryInspector. The query may be modified by converting the inspector back to a RaceProcessorQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyRaceProcessorQuery(RaceProcessorQuery raceProcessorQuery) Applies a race processor query to this polls.
void	applyRaceProcessorSequencing(RaceProcessorSearchOrder raceProcessorSearchOrder) Applies a race processor 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.
RaceProcessorQuery	getRaceProcessorQuery() Gets a race processor query.
RaceProcessorQuery	getRaceProcessorQueryFromInspector(RaceProcessorQueryInspector raceProcessorQueryInspector) Gets a race processor query from an inspector.
RaceProcessorSearchOrder	getRaceProcessorSearchOrder() Gets a race processor search order.
RaceProcessorQueryInspector	inspectRaceProcessorQuery() Gets a race processor 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.

getRaceProcessorQuery

RaceProcessorQuery getRaceProcessorQuery()

Gets a race processor query.

Returns:

the race processor query

Compliance:

mandatory - This method must be implemented.

getRaceProcessorSearchOrder

RaceProcessorSearchOrder getRaceProcessorSearchOrder()

Gets a race processor search order.

Returns:

the race processor search order

Compliance:

mandatory - This method must be implemented.

applyRaceProcessorQuery

void applyRaceProcessorQuery(RaceProcessorQuery raceProcessorQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a race processor query to this polls.

Parameters:

raceProcessorQuery - the race processor query

Throws:

NullArgumentException - raceProcessorQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - raceProcessorQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRaceProcessorQuery

RaceProcessorQueryInspector inspectRaceProcessorQuery()
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a race processor query inspector for this polls.

Returns:

the race processor query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRaceProcessorSequencing

void applyRaceProcessorSequencing(RaceProcessorSearchOrder raceProcessorSearchOrder)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Applies a race processor search order to this polls.

Parameters:

raceProcessorSearchOrder - the race processor search order

Throws:

NullArgumentException - raceProcessorSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - raceProcessorSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRaceProcessorQueryFromInspector

RaceProcessorQuery getRaceProcessorQueryFromInspector(RaceProcessorQueryInspector raceProcessorQueryInspector)

Gets a race processor query from an inspector.

Parameters:

raceProcessorQueryInspector - a race processor query inspector

Returns:

the race processor query

Throws:

NullArgumentException - raceProcessorQueryInspector is null

UnsupportedException - raceProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.