OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
voting package
Version 3.0.0
Release Candidate Preview
| Interface | osid.voting.CandidateSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing candidate searches. | ||
| Method | searchAmongCandidates | ||
| Description |
Execute this search among the given list of candidates. | ||
| Parameters | osid.id.IdList | candidateIds | list of candidate Ids |
| Errors | NULL_ARGUMENT | candidateIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCandidateResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.voting.CandidateSearchOrder | candidateSearchOrder | candidate search order |
| Errors | NULL_ARGUMENT | order is null | |
| UNSUPPORTED | order is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCandidateSearchRecord | ||
| Description |
Gets the candidate search record corresponding to the
given candidate search record | ||
| Parameters | osid.type.Type | candidateSearchRecordType | a candidate search record type |
| Return | osid.voting.records.CandidateSearchRecord | the candidate search record | |
| Errors | NULL_ARGUMENT | candidateSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordTypeType(candidateSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |