OSID Logo
OSID Specifications
voting package
Version 3.1.0
Interfaceosid.voting.BallotSearch
Implementsosid.OsidSearch
Used Byosid.voting.BallotSearchSession
Description

The search interface for governing ballot searches.

MethodsearchAmongBallots
Description

Execute this search among the given list of ballots.

Parametersosid.id.IdListballotIds list of ballot Ids
ErrorsNULL_ARGUMENT ballotIds is null
Compliancemandatory This method must be implemented.
MethodorderBallotResults
Description

Specify an ordering to the search results.

Parametersosid.voting.BallotSearchOrderballotSearchOrder ballot search order
ErrorsNULL_ARGUMENT order is null
UNSUPPORTED order is not of this service
Compliancemandatory This method must be implemented.
MethodgetBallotSearchRecord
Description

Gets the ballot search 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.BallotSearchRecord the ballot search record
ErrorsNULL_ARGUMENT ballotSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(ballotSearchRecordType) is false
Compliancemandatory This method must be implemented.