org.osid.voting

Interface PollsSearchSession

All Superinterfaces:

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

public interface PollsSearchSession
extends PollsQuerySession

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

getPollsByQuery() is the basic search method and returns a list of Polls objects.A more advanced search may be performed with getPollsBySearch(). It accepts a PollsSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPollsBySearch() returns a PollsSearchResults that can be used to access the resulting PollsList or be used to perform a search within the result set through PollsSearch.

Polls may have a polls query record indicated by their respective record types. The polls query record is accessed via the PollsQuery.

Method Summary

Methods

Modifier and Type	Method and Description
PollsQuery	getPollsQueryFromInspector(PollsQueryInspector pollsQueryInspector) Gets a polls query from an inspector.
PollsSearchResults	getPollssBySearch(PollsQuery pollsQuery, PollsSearch pollsSearch) Gets the search results matching the given search query using the given search.
PollsSearch	getPollsSearch() Gets a polls search.
PollsSearchOrder	getPollsSearchOrder() Gets a polls search order.

Methods inherited from interface org.osid.voting.PollsQuerySession

canSearchPolls, getPollsByQuery, getPollsQuery

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

getPollsSearch

PollsSearch getPollsSearch()

Gets a polls search.

Returns:

the polls search

Compliance:

mandatory - This method must be implemented.

getPollsSearchOrder

PollsSearchOrder getPollsSearchOrder()

Gets a polls search order. The PollsSearchOrder is supplied to a PollsSearch to specify the ordering of results.

Returns:

the polls search order

Compliance:

mandatory - This method must be implemented.

getPollssBySearch

PollsSearchResults getPollssBySearch(PollsQuery pollsQuery,
                                   PollsSearch pollsSearch)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

pollsQuery - the polls query

pollsSearch - the polls search

Returns:

the polls search results

Throws:

NullArgumentException - pollsQuery or pollsSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - pollsQuery or pollsSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPollsQueryFromInspector

PollsQuery getPollsQueryFromInspector(PollsQueryInspector pollsQueryInspector)

Gets a polls query from an inspector. The inspector is available from a PollsSearchResults.

Parameters:

pollsQueryInspector - a polls query inspector

Returns:

the polls query

Throws:

NullArgumentException - pollsQueryInspector is null

UnsupportedException - pollsQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.