Interface BallotSearchSession

All Superinterfaces:

AutoCloseable, BallotQuerySession, Closeable, OsidSession, OsidSession

public interface BallotSearchSession
extends BallotQuerySession

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

getBallotsByQuery() is the basic search method and returns a list of Ballots . A more advanced search may be performed with getBallotsBySearch() .It accepts an BallotSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBallotsBySearch() returns an BallotSearchResults that can be used to access the resulting BallotList or be used to perform a search within the result set through BallotList .

This session defines views that offer differing behaviors for searching.

• federated polls view: searches include ballots in polls of which this polls is a ancestor in the polls hierarchy
• isolated polls view: searches are restricted to ballots in this polls

Ballots may have a ballot query record indicated by their respective record types. The ballot query record is accessed via the BallotQuery .

Method Summary

Modifier and Type	Method	Description
BallotQuery	getBallotQueryFromInspector(BallotQueryInspector ballotQueryInspector)	Gets a ballot query from an inspector.
BallotSearchResults	getBallotsBySearch(BallotQuery ballotQuery, BallotSearch ballotSearch)	Gets the search results matching the given search query using the given search.
BallotSearch	getBallotSearch()	Gets a ballot search.
BallotSearchOrder	getBallotSearchOrder()	Gets a ballot search order.

Methods inherited from interface BallotQuerySession

canSearchBallots, getBallotQuery, getBallotsByQuery, getPolls, getPollsId, useFederatedPollsView, useIsolatedPollsView

Modifier and Type	Method	Description
boolean	canSearchBallots()	Tests if this user can perform Ballot searches.
BallotQuery	getBallotQuery()	Gets a ballot query.
BallotList	getBallotsByQuery(BallotQuery ballotQuery)	Gets a list of Ballots matching the given query.
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
void	useFederatedPollsView()	Federates the view for methods in this session.
void	useIsolatedPollsView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getBallotSearch

BallotSearch getBallotSearch()

Gets a ballot search.

Returns:

the ballot search

Compliance:

mandatory - This method must be implemented.

getBallotSearchOrder

BallotSearchOrder getBallotSearchOrder()

Gets a ballot search order. The BallotSearchOrder is supplied to a BallotSearch to specify the ordering of results.

Returns:

the ballot search order

Compliance:

mandatory - This method must be implemented.

getBallotsBySearch

BallotSearchResults getBallotsBySearch(BallotQuery ballotQuery,
 BallotSearch ballotSearch)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

ballotQuery - the ballot query

ballotSearch - the ballot search

Returns:

the returned search results

Throws:

NullArgumentException - ballotQuery or ballotSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - ballotQuery or ballotSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBallotQueryFromInspector

BallotQuery getBallotQueryFromInspector(BallotQueryInspector ballotQueryInspector)

Gets a ballot query from an inspector. The inspector is available from a BallotSearchResults .

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.