org.osid.voting.rules

Interface RaceConstrainerEnablerSmartPollsSession

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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.

getRaceConstrainerEnablerQuery

RaceConstrainerEnablerQuery getRaceConstrainerEnablerQuery()

Gets a race constrainer enabler query.

Returns:

the race constrainer enabler query

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerEnablerSearchOrder

RaceConstrainerEnablerSearchOrder getRaceConstrainerEnablerSearchOrder()

Gets a race constrainer enabler search order.

Returns:

the race constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

applyRaceConstrainerEnablerQuery

void applyRaceConstrainerEnablerQuery(RaceConstrainerEnablerQuery raceConstrainerEnablerQuery)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Applies a race constrainer enabler query to this polls.

Parameters:

raceConstrainerEnablerQuery - the race constrainer enabler query

Throws:

NullArgumentException - raceConstrainerEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - raceConstrainerEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRaceConstrainerEnablerQuery

RaceConstrainerEnablerQueryInspector inspectRaceConstrainerEnablerQuery()
                                                                        throws OperationFailedException,
                                                                               PermissionDeniedException

Gets a race constrainer enabler query inspector for this polls.

Returns:

the race constrainer enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRaceConstrainerEnablerSequencing

void applyRaceConstrainerEnablerSequencing(RaceConstrainerEnablerSearchOrder raceConstrainerEnablerSearchOrder)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Applies a race constrainer enabler search order to this polls.

Parameters:

raceConstrainerEnablerSearchOrder - the race constrainer enabler search order

Throws:

NullArgumentException - raceConstrainerEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - raceConstrainerEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerEnablerQueryFromInspector

RaceConstrainerEnablerQuery getRaceConstrainerEnablerQueryFromInspector(RaceConstrainerEnablerQueryInspector raceConstrainerEnablerQueryInspector)

Gets a race constrainer enabler query from an inspector.

Parameters:

raceConstrainerEnablerQueryInspector - a race constrainer enabler query inspector

Returns:

the race constrainer enabler query

Throws:

NullArgumentException - raceConstrainerEnablerQueryInspector is null

UnsupportedException - raceConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.