OSID Logo
OSID Specifications
voting rules package
Version 3.1.0
Interfaceosid.voting.rules.BallotConstrainerSearch
Implementsosid.OsidSearch
Used Byosid.voting.rules.BallotConstrainerSearchSession
Description

The search interface for governing ballot constrainer searches.

MethodsearchAmongBallotConstrainers
Description

Execute this search among the given list of ballot constrainers.

Parametersosid.id.IdListpollsIds list of ballot constrainers
ErrorsNULL_ARGUMENT pollsIds is null
Compliancemandatory This method must be implemented.
MethodorderBallotConstrainerResults
Description

Specify an ordering to the search results.

Parametersosid.voting.rules.BallotConstrainerSearchOrderballotConstrainerSearchOrder ballot constrainer search order
ErrorsNULL_ARGUMENT ballotConstrainerSearchOrder is null
UNSUPPORTED ballotConstrainerSearchOrder is not of this service
Compliancemandatory This 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.TypeballotConstrainerSearchRecordType a ballot constrainer search record type
Returnosid.voting.rules.records.BallotConstrainerSearchRecord the ballot constrainer search record
ErrorsNULL_ARGUMENT ballotConstrainerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(ballotConstrainerSearchRecordType) is false
Compliancemandatory This method must be implemented.