OSID Logo
OSID Specifications
voting package
Version 3.0.0
Interfaceosid.voting.CandidateSearch
Implementsosid.OsidSearch
Used Byosid.voting.CandidateSearchSession
Description

The search interface for governing candidate searches.

MethodsearchAmongCandidates
Description

Execute this search among the given list of candidates.

Parametersosid.id.IdListcandidateIdslist of candidate Ids
ErrorsNULL_ARGUMENTcandidateIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCandidateResults
Description

Specify an ordering to the search results.

Parametersosid.voting.CandidateSearchOrdercandidateSearchOrdercandidate search order
ErrorsNULL_ARGUMENTorder is null
UNSUPPORTEDorder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCandidateSearchRecord
Description

Gets the candidate search 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.CandidateSearchRecordthe candidate search record
ErrorsNULL_ARGUMENTcandidateSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordTypeType(candidateSearchRecordType) is false
CompliancemandatoryThis method must be implemented.