Interface VoteEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, VoteEnablerQuerySession

public interface VoteEnablerSearchSession
extends VoteEnablerQuerySession

This session provides methods for searching among VoteEnablers . The search query is constructed using the VoteEnablerQuery .

getVoteEnablersByQuery() is the basic search method and returns a list of VoteEnablers . A more advanced search may be performed with getVoteEnablersBySearch() .It accepts a VoteEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getVoteEnablersBySearch() returns a VoteEnablerSearchResults that can be used to access the resulting VoteEnablerList or be used to perform a search within the result set through Vot eEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

Vote enablers may have a query record indicated by their respective record types. The query record is accessed via the VoteEnablerQuery .

Method Summary

Modifier and Type	Method	Description
VoteEnablerQuery	getVoteEnablerQueryFromInspector(VoteEnablerQueryInspector voteEnablerQueryInspector)	Gets a vote enabler query from an inspector.
VoteEnablerSearchResults	getVoteEnablersBySearch(VoteEnablerQuery voteEnablerQuery, VoteEnablerSearch voteEnablerSearch)	Gets the search results matching the given search query using the given search.
VoteEnablerSearch	getVoteEnablerSearch()	Gets a vote enabler search.
VoteEnablerSearchOrder	getVoteEnablerSearchOrder()	Gets a vote enabler search order.

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.

Methods inherited from interface VoteEnablerQuerySession

canSearchVoteEnablers, getPolls, getPollsId, getVoteEnablerQuery, getVoteEnablersByQuery, useFederatedPollsView, useIsolatedPollsView

Modifier and Type	Method	Description
boolean	canSearchVoteEnablers()	Tests if this user can perform VoteEnabler searches.
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
VoteEnablerQuery	getVoteEnablerQuery()	Gets a vote enabler query.
VoteEnablerList	getVoteEnablersByQuery(VoteEnablerQuery voteEnablerQuery)	Gets a list of VoteEnablers matching the given search.
void	useFederatedPollsView()	Federates the view for methods in this session.
void	useIsolatedPollsView()	Isolates the view for methods in this session.

Method Details

getVoteEnablerSearch

VoteEnablerSearch getVoteEnablerSearch()

Gets a vote enabler search.

Returns:

the vote enabler search

Compliance:

mandatory - This method must be implemented.

getVoteEnablerSearchOrder

VoteEnablerSearchOrder getVoteEnablerSearchOrder()

Gets a vote enabler search order. The VoteEnablerSearchOrder is supplied to a VoteEnablerSearch to specify the ordering of results.

Returns:

the vote enabler search order

Compliance:

mandatory - This method must be implemented.

getVoteEnablersBySearch

VoteEnablerSearchResults getVoteEnablersBySearch(VoteEnablerQuery voteEnablerQuery,
 VoteEnablerSearch voteEnablerSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

voteEnablerQuery - the vote enabler query

voteEnablerSearch - the vote enabler search

Returns:

the returned search results

Throws:

NullArgumentException - voteEnablerQuery or voteEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - voteEnablerQuery or voteEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getVoteEnablerQueryFromInspector

VoteEnablerQuery getVoteEnablerQueryFromInspector(VoteEnablerQueryInspector voteEnablerQueryInspector)

Gets a vote enabler query from an inspector. The inspector is available from a VoteEnablerSearchResults .

Parameters:

voteEnablerQueryInspector - a vote enabler query inspector

Returns:

the vote enabler query

Throws:

NullArgumentException - voteEnablerQueryInspector is null

UnsupportedException - voteEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.