org.osid.voting.rules

Interface RaceConstrainerSmartPollsSession

All Superinterfaces:

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

public interface RaceConstrainerSmartPollsSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic polls. a RaceConstrainerQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of race constrainers. The race constrainer may be sequenced using the RaceConstrainerSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyRaceConstrainerQuery(RaceConstrainerQuery raceConstrainerQuery) Applies a race constrainer query to this polls.
void	applyRaceConstrainerSequencing(RaceConstrainerSearchOrder raceConstrainerSearchOrder) Applies a race constrainer 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.
RaceConstrainerQuery	getRaceConstrainerQuery() Gets a race constrainer query.
RaceConstrainerQuery	getRaceConstrainerQueryFromInspector(RaceConstrainerQueryInspector raceConstrainerQueryInspector) Gets a race constrainer query from an inspector.
RaceConstrainerSearchOrder	getRaceConstrainerSearchOrder() Gets a race constrainer search order.
RaceConstrainerQueryInspector	inspectRaceConstrainerQuery() Gets a race constrainer 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.

getRaceConstrainerQuery

RaceConstrainerQuery getRaceConstrainerQuery()

Gets a race constrainer query.

Returns:

the race constrainer query

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerSearchOrder

RaceConstrainerSearchOrder getRaceConstrainerSearchOrder()

Gets a race constrainer search order.

Returns:

the race constrainer search order

Compliance:

mandatory - This method must be implemented.

applyRaceConstrainerQuery

void applyRaceConstrainerQuery(RaceConstrainerQuery raceConstrainerQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Applies a race constrainer query to this polls.

Parameters:

raceConstrainerQuery - the race constrainer query

Throws:

NullArgumentException - raceConstrainerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - raceConstrainerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRaceConstrainerQuery

RaceConstrainerQueryInspector inspectRaceConstrainerQuery()
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets a race constrainer query inspector for this polls.

Returns:

the race constrainer query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRaceConstrainerSequencing

void applyRaceConstrainerSequencing(RaceConstrainerSearchOrder raceConstrainerSearchOrder)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Applies a race constrainer search order to this polls.

Parameters:

raceConstrainerSearchOrder - the race constrainer search order

Throws:

NullArgumentException - raceConstrainerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - raceConstrainerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRaceConstrainerQueryFromInspector

RaceConstrainerQuery getRaceConstrainerQueryFromInspector(RaceConstrainerQueryInspector raceConstrainerQueryInspector)

Gets a race constrainer query from an inspector.

Parameters:

raceConstrainerQueryInspector - a race constrainer query inspector

Returns:

the race constrainer query

Throws:

NullArgumentException - raceConstrainerQueryInspector is null

UnsupportedException - raceConstrainerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.