OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.PollsSearchSession
Implementsosid.voting.PollsQuerySession
Description

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.

MethodgetPollsSearch
Description

Gets a polls search.

Returnosid.voting.PollsSearchthe polls search
CompliancemandatoryThis method must be implemented.
MethodgetPollsSearchOrder
Description

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

Returnosid.voting.PollsSearchOrderthe polls search order
CompliancemandatoryThis method must be implemented.
MethodgetPollssBySearch
Description

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

Parametersosid.voting.PollsQuerypollsQuerythe polls query
osid.voting.PollsSearchpollsSearchthe polls search
Returnosid.voting.PollsSearchResultsthe polls search results
ErrorsNULL_ARGUMENT pollsQuery or pollsSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED pollsQuery or pollsSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPollsQueryFromInspector
Description

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

Parametersosid.voting.PollsQueryInspectorpollsQueryInspectora polls query inspector
Returnosid.voting.PollsQuerythe polls query
ErrorsNULL_ARGUMENT pollsQueryInspector is null
UNSUPPORTED pollsQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.