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

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

MethodgetBallotConstrainerEnablers
Description

Gets the BallotConstrainerEnablerList resulting from a search.

Returnosid.voting.rules.BallotConstrainerEnablerListthe ballot constrainer enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablerQueryInspector
Description

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

Returnosid.voting.rules.BallotConstrainerEnablerQueryInspectorthe ballot constrainer enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablerSearchResultsRecord
Description

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

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