org.osid.voting

Interface BallotSmartPollsSession

All Superinterfaces:

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

public interface BallotSmartPollsSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A BallotQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of Ballots. The ballots may be sequenced using the BallotSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyBallotQuery(BallotQuery ballotQuery) Applies a ballot query to this polls.
void	applyBallotSequencing(BallotSearchOrder ballotSearchOrder) Applies a ballot search order to this polls.
boolean	canManageSmartPolls() Tests if this user can manage smart polls.
BallotQuery	getBallotQuery() Gets a ballot query.
BallotQuery	getBallotQueryFromInspector(BallotQueryInspector ballotQueryInspector) Gets a ballot query from an inspector.
BallotSearchOrder	getBallotSearchOrder() Gets a ballot search order.
Polls	getPolls() Gets the Polls associated with this session.
Id	getPollsId() Gets the Polls Id associated with this session.
BallotQueryInspector	inspectBallotQuery() Gets a ballot 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 associated with this session

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.

getBallotQuery

BallotQuery getBallotQuery()

Gets a ballot query.

Returns:

the ballot query

Compliance:

mandatory - This method must be implemented.

getBallotSearchOrder

BallotSearchOrder getBallotSearchOrder()

Gets a ballot search order.

Returns:

the ballot search order

Compliance:

mandatory - This method must be implemented.

applyBallotQuery

void applyBallotQuery(BallotQuery ballotQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies a ballot query to this polls.

Parameters:

ballotQuery - the ballot query

Throws:

NullArgumentException - ballotQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - ballotQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectBallotQuery

BallotQueryInspector inspectBallotQuery()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a ballot query inspector for this polls.

Returns:

the ballot query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyBallotSequencing

void applyBallotSequencing(BallotSearchOrder ballotSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies a ballot search order to this polls.

Parameters:

ballotSearchOrder - the ballot search order

Throws:

NullArgumentException - ballotSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - ballotSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getBallotQueryFromInspector

BallotQuery getBallotQueryFromInspector(BallotQueryInspector ballotQueryInspector)

Gets a ballot query from an inspector.

Parameters:

ballotQueryInspector - a ballot query inspector

Returns:

the ballot query

Throws:

NullArgumentException - ballotQueryInspector is null

UnsupportedException - ballotQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.