OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.BallotConstrainerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetBallotConstrainers
Description

Gets the BallotConstrainerList resulting from a search.

Returnosid.voting.rules.BallotConstrainerListthe ballot constrainer list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerQueryInspector
Description

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

Returnosid.voting.rules.BallotConstrainerQueryInspectorthe ballot constrainer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerSearchResultsRecord
Description

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

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