org.osid.voting

Interface PollsQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

PollsSearchSession

public interface PollsQuerySession
extends OsidSession

This session provides methods for searching among Polls objects. The search query is constructed using the PollsQuery.

Polls may have a polls query record indicated by their respective record types. The polls query record is accessed via the PollsQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchPolls() Tests if this user can perform Polls searches.
PollsList	getPollsByQuery(PollsQuery pollsQuery) Gets a list of Polls matching the given query.
PollsQuery	getPollsQuery() Gets a polls query.

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

canSearchPolls

boolean canSearchPolls()

Tests if this user can perform Polls searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPollsQuery

PollsQuery getPollsQuery()

Gets a polls query.

Returns:

the polls query

Compliance:

mandatory - This method must be implemented.

getPollsByQuery

PollsList getPollsByQuery(PollsQuery pollsQuery)
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets a list of Polls matching the given query.

Parameters:

pollsQuery - the polls query

Returns:

the returned PollsList

Throws:

NullArgumentException - pollsQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - a pollsQuery is not of this service

Compliance:

mandatory - This method must be implemented.