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

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

MethodgetBallots
Description

Gets the ballot list resulting from a search.

Returnosid.voting.BallotListthe ballot list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBallotQueryInspector
Description

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

Returnosid.voting.BallotQueryInspectorthe ballot query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBallotSearchResultsRecord
Description

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

Parametersosid.type.TypeballotSearchRecordTypea ballot search record type
Returnosid.voting.records.BallotSearchResultsRecordthe ballot search results record
ErrorsNULL_ARGUMENT ballotSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(ballotSearchRecordType) is false
CompliancemandatoryThis method must be implemented.