OSID Logo
OSID Specifications
voting package
Version 3.1.0
Interfaceosid.voting.BallotSearchResults
Implementsosid.OsidSearchResults
Used Byosid.voting.BallotSearchSession
Description

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

MethodgetBallots
Description

Gets the ballot list resulting from a search.

Returnosid.voting.BallotList the ballot list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetBallotQueryInspector
Description

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

Returnosid.voting.BallotQueryInspector the ballot query inspector
Compliancemandatory This 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.TypeballotSearchRecordType a ballot search record type
Returnosid.voting.records.BallotSearchResultsRecord the ballot search results record
ErrorsNULL_ARGUMENT ballotSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(ballotSearchRecordType) is false
Compliancemandatory This method must be implemented.