OSID Logo
OSID Specifications
voting rules package
Version 3.1.0
Interfaceosid.voting.rules.BallotConstrainerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.voting.rules.BallotConstrainerSearchSession
Description

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

MethodgetBallotConstrainers
Description

Gets the BallotConstrainerList resulting from a search.

Returnosid.voting.rules.BallotConstrainerList the ballot constrainer list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetBallotConstrainerQueryInspector
Description

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

Returnosid.voting.rules.BallotConstrainerQueryInspector the ballot constrainer query inspector
Compliancemandatory This 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.TypeballotConstrainerSearchRecordType a ballot constrainer search record type
Returnosid.voting.rules.records.BallotConstrainerSearchResultsRecord the ballot constrainer search results record
ErrorsNULL_ARGUMENT ballotConstrainerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(ballotConstrainerSearchRecordType) is false
Compliancemandatory This method must be implemented.