OSID Logo
OSID Specifications
voting rules package
Version 3.0.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.IdListpollsIdslist of ballot constrainers
ErrorsNULL_ARGUMENTpollsIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBallotConstrainerResults
Description

Specify an ordering to the search results.

Parametersosid.voting.rules.BallotConstrainerSearchOrderballotConstrainerSearchOrderballot constrainer search order
ErrorsNULL_ARGUMENTballotConstrainerSearchOrder is null
UNSUPPORTEDballotConstrainerSearchOrder 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_ARGUMENTballotConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(ballotConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.