OSID Logo
OSID Specifications
voting rules package
Version 3.1.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.VoteEnablerList the vote enabler list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetVoteEnablerQueryInspector
Description

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

Returnosid.voting.rules.VoteEnablerQueryInspector the vote enabler query inspector
Compliancemandatory This 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.TypevoteEnablerSearchRecordType a vote enabler search record type
Returnosid.voting.rules.records.VoteEnablerSearchResultsRecord the vote enabler search results record
ErrorsNULL_ARGUMENT voteEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(voteEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.