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

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

MethodgetCandidates
Description

Gets the candidate list resulting from a search.

Returnosid.voting.CandidateListthe candidate list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCandidateQueryInspector
Description

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

Returnosid.voting.CandidateQueryInspectorthe candidate query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCandidateSearchResultsRecord
Description

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

Parametersosid.type.TypecandidateSearchRecordTypea candidate search record type
Returnosid.voting.records.CandidateSearchResultsRecordthe candidate search results record
ErrorsNULL_ARGUMENT candidateSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(candidateSearchRecordType) is false
CompliancemandatoryThis method must be implemented.