OSID Logo
OSID Specifications
voting package
Version 3.1.0
Interfaceosid.voting.CandidateSearchResults
Implementsosid.OsidSearchResults
Used Byosid.voting.CandidateSearchSession
Description

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

MethodgetCandidates
Description

Gets the candidate list resulting from a search.

Returnosid.voting.CandidateList the candidate list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetCandidateQueryInspector
Description

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

Returnosid.voting.CandidateQueryInspector the candidate query inspector
Compliancemandatory This 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.TypecandidateSearchRecordType a candidate search record type
Returnosid.voting.records.CandidateSearchResultsRecord the candidate search results record
ErrorsNULL_ARGUMENT candidateSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(candidateSearchRecordType) is false
Compliancemandatory This method must be implemented.