org.osid.voting.rules

Interface BallotConstrainerEnablerSearchSession

All Superinterfaces:

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

public interface BallotConstrainerEnablerSearchSession
extends BallotConstrainerEnablerQuerySession

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

getBallotConstrainerEnablersByQuery() is the basic search method and returns a list of BallotConstrainerEnablers. A more advanced search may be performed with getBallotConstrainerEnablersBySearch(). It accepts a BallotConstrainerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. getBallotConstrainerEnablersBySearch() returns a BallotConstrainerEnablerSearchResults that can be used to access the resulting BallotConstrainerEnablerList or be used to perform a search within the result set through BallotConstrainerEnablerSearch.

This session defines views that offer differing behaviors for searching.

• federated polls view: searches include ballot constrainer enablers in polls of which this polls is an ancestor in the polls hierarchy
• isolated polls view: searches are restricted to ballot constrainer enablers in this polls

BallotConstrainerEnablers may have a query record indicated by their respective record types. The query record is accessed via the BallotConstrainerEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
BallotConstrainerEnablerQuery	getBallotConstrainerEnablerQueryFromInspector(BallotConstrainerEnablerQueryInspector ballotConstrainerEnablerQueryInspector) Gets a ballot constrainer enabler query from an inspector.
BallotConstrainerEnablerSearchResults	getBallotConstrainerEnablersBySearch(BallotConstrainerEnablerQuery ballotConstrainerEnablerQuery, BallotConstrainerEnablerSearch ballotConstrainerEnablerSearch) Gets the search results matching the given search query using the given search.
BallotConstrainerEnablerSearch	getBallotConstrainerEnablerSearch() Gets a ballot constrainer enabler search.
BallotConstrainerEnablerSearchOrder	getBallotConstrainerEnablerSearchOrder() Gets a ballot constrainer enabler search order.

Methods inherited from interface org.osid.voting.rules.BallotConstrainerEnablerQuerySession

canSearchBallotConstrainerEnablers, getBallotConstrainerEnablerQuery, getBallotConstrainerEnablersByQuery, getPolls, getPollsId, useFederatedPollsView, useIsolatedPollsView

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

getBallotConstrainerEnablerSearch

BallotConstrainerEnablerSearch getBallotConstrainerEnablerSearch()

Gets a ballot constrainer enabler search.

Returns:

the ballot constrainer enabler search

Compliance:

mandatory - This method must be implemented.

getBallotConstrainerEnablerSearchOrder

BallotConstrainerEnablerSearchOrder getBallotConstrainerEnablerSearchOrder()

Gets a ballot constrainer enabler search order. The BallotConstrainerEnablerSearchOrder is supplied to a BallotConstrainerEnablerSearch to specify the ordering of results.

Returns:

the ballot constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

getBallotConstrainerEnablersBySearch

BallotConstrainerEnablerSearchResults getBallotConstrainerEnablersBySearch(BallotConstrainerEnablerQuery ballotConstrainerEnablerQuery,
                                                                         BallotConstrainerEnablerSearch ballotConstrainerEnablerSearch)
                                                                           throws OperationFailedException,
                                                                                  PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

ballotConstrainerEnablerQuery - the ballot constrainer enabler query

ballotConstrainerEnablerSearch - the ballot constrainer enabler search

Returns:

the returned search results

Throws:

NullArgumentException - ballotConstrainerEnablerQuery or ballotConstrainerEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - ballotConstrainerEnablerQuery or ballotConstrainerEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBallotConstrainerEnablerQueryFromInspector

BallotConstrainerEnablerQuery getBallotConstrainerEnablerQueryFromInspector(BallotConstrainerEnablerQueryInspector ballotConstrainerEnablerQueryInspector)

Gets a ballot constrainer enabler query from an inspector. The inspector is available from a BallotConstrainerEnablerSearchResults.

Parameters:

ballotConstrainerEnablerQueryInspector - a ballot constrainer enabler query inspector

Returns:

the ballot constrainer enabler query

Throws:

NullArgumentException - ballotConstrainerEnablerQueryInspector is null

UnsupportedException - ballotConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.