OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.VoteSearchSession
Implementsosid.voting.VoteQuerySession
Description

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.

MethodgetVoteSearch
Description

Gets a vote search.

Returnosid.voting.VoteSearchthe vote search
CompliancemandatoryThis method must be implemented.
MethodgetVoteSearchOrder
Description

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

Returnosid.voting.VoteSearchOrderthe vote search order
CompliancemandatoryThis method must be implemented.
MethodgetVotesBySearch
Description

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

Parametersosid.voting.VoteQueryvoteQuerythe vote search query
osid.voting.VoteSearchvoteSearchthe vote search
Returnosid.voting.VoteSearchResultsthe returned search results
ErrorsNULL_ARGUMENT voteQuery or voteSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED voteSearch or voteQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetVoteQueryFromInspector
Description

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

Parametersosid.voting.VoteQueryInspectorvoteQueryInspectora vote query inspector
Returnosid.voting.VoteQuerythe vote query
ErrorsNULL_ARGUMENT voteQueryInspector is null
UNSUPPORTED voteQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.