OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.VoteSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetVotes
Description

Gets the vote list resulting from the search.

Returnosid.voting.VoteListthe vote list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetVoteQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.voting.VoteQueryInspectorthe vote query inspector
CompliancemandatoryThis method must be implemented.
MethodgetVoteSearchResultsRecord
Description

Gets the vote search results record corresponding to the given vote search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypevoteSearchRecordTypea vote search record type
Returnosid.voting.records.VoteSearchResultsRecordthe vote search results record
ErrorsNULL_ARGUMENT voteSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(voteSearchRecordType) is false
CompliancemandatoryThis method must be implemented.