Interface VoteSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, VoteQuerySession

public interface VoteSearchSession
extends VoteQuerySession

This session provides methods for searching Vote objects. The search query is constructed using the VoteQuery . The vote record Type also specifies the record for the vote query.

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

This session defines views that offer differing behaviors for searching.

• federated polls view: searches include votes in polls of which these polls is an ancestor in the polls hierarchy
• isolated polls view: searches are restricted to votes in these polls only

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

Method Summary

Modifier and Type	Method	Description
VoteQuery	getVoteQueryFromInspector(VoteQueryInspector voteQueryInspector)	Gets a vote query from an inspector.
VoteSearchResults	getVotesBySearch(VoteQuery voteQuery, VoteSearch voteSearch)	Gets the search results matching the given search query using the given search.
VoteSearch	getVoteSearch()	Gets a vote search.
VoteSearchOrder	getVoteSearchOrder()	Gets a vote 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 VoteQuerySession

canSearchVotes, getPolls, getPollsId, getVoteQuery, getVotesByQuery, useFederatedPollsView, useIsolatedPollsView

Modifier and Type	Method	Description
boolean	canSearchVotes()	Tests if this user can perform Vote searches.
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
VoteQuery	getVoteQuery()	Gets a vote query.
VoteList	getVotesByQuery(VoteQuery voteQuery)	Gets a list of Vote matching the given vote query.
void	useFederatedPollsView()	Federates the view for methods in this session.
void	useIsolatedPollsView()	Isolates the view for methods in this session.

Method Details

getVoteSearch

VoteSearch getVoteSearch()

Gets a vote search.

Returns:

the vote search

Compliance:

mandatory - This method must be implemented.

getVoteSearchOrder

VoteSearchOrder getVoteSearchOrder()

Gets a vote search order. The VoteSearchOrder is supplied to a VoteSearch to specify the ordering of results.

Returns:

the vote search order

Compliance:

mandatory - This method must be implemented.

getVotesBySearch

VoteSearchResults getVotesBySearch(VoteQuery voteQuery,
 VoteSearch voteSearch)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

voteQuery - the vote search query

voteSearch - the vote search

Returns:

the returned search results

Throws:

NullArgumentException - voteQuery or voteSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - voteSearch or voteQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getVoteQueryFromInspector

VoteQuery getVoteQueryFromInspector(VoteQueryInspector voteQueryInspector)

Gets a vote query from an inspector. The inspector is available from a VoteSearchResults .

Parameters:

voteQueryInspector - a vote query inspector

Returns:

the vote query

Throws:

NullArgumentException - voteQueryInspector is null

UnsupportedException - voteQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.