OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Interfaceosid.voting.rules.VoteEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.voting.rules.VoteEnablerSearchSession
Description

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

MethodgetVoteEnablers
Description

Gets the vote enabler list resulting from a search.

Returnosid.voting.rules.VoteEnablerListthe vote enabler list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetVoteEnablerQueryInspector
Description

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

Returnosid.voting.rules.VoteEnablerQueryInspectorthe vote enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetVoteEnablerSearchResultsRecord
Description

Gets the vote enabler search results record corresponding to the given vote enabler search record Type .This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypevoteEnablerSearchRecordTypea vote enabler search record type
Returnosid.voting.rules.records.VoteEnablerSearchResultsRecordthe vote enabler search results record
ErrorsNULL_ARGUMENTvoteEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(voteEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.