OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.BallotConstrainerSearch
Implementsosid.OsidSearch
Description

The search interface for governing ballot constrainer searches.

MethodsearchAmongBallotConstrainers
Description

Execute this search among the given list of ballot constrainers.

Parametersosid.id.IdListpollsIdslist of ballot constrainers
ErrorsNULL_ARGUMENT pollsIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBallotConstrainerResults
Description

Specify an ordering to the search results.

Parametersosid.voting.rules.BallotConstrainerSearchOrderballotConstrainerSearchOrderballot constrainer search order
ErrorsNULL_ARGUMENT ballotConstrainerSearchOrder is null
UNSUPPORTED ballotConstrainerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerSearchRecord
Description

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

Parametersosid.type.TypeballotConstrainerSearchRecordTypea ballot constrainer search record type
Returnosid.voting.rules.records.BallotConstrainerSearchRecordthe ballot constrainer search record
ErrorsNULL_ARGUMENT ballotConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(ballotConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.