OSID Logo
OSID Specifications
voting package
Version 3.1.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.IdListcandidateIds list of candidate Ids
ErrorsNULL_ARGUMENT candidateIds is null
Compliancemandatory This method must be implemented.
MethodorderCandidateResults
Description

Specify an ordering to the search results.

Parametersosid.voting.CandidateSearchOrdercandidateSearchOrder candidate search order
ErrorsNULL_ARGUMENT order is null
UNSUPPORTED order is not of this service
Compliancemandatory This 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.TypecandidateSearchRecordType a candidate search record type
Returnosid.voting.records.CandidateSearchRecord the candidate search record
ErrorsNULL_ARGUMENT candidateSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(candidateSearchRecordType) is false
Compliancemandatory This method must be implemented.