org.osid.voting

Interface VoteSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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 a 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

Methods

Modifier and Type	Method and 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 org.osid.voting.VoteQuerySession

canSearchVotes, getPolls, getPollsId, getVoteQuery, getVotesByQuery, 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

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.