Interface | osid.voting.CandidateSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCandidates | ||
Description |
Gets the candidate list resulting from a search. | ||
Return | osid.voting.CandidateList | the candidate list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCandidateQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.voting.CandidateQueryInspector | the candidate query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCandidateSearchResultsRecord | ||
Description |
Gets the candidate search results record corresponding
to the given candidate search record | ||
Parameters | osid.type.Type | candidateSearchRecordType | a candidate search record type |
Return | osid.voting.records.CandidateSearchResultsRecord | the candidate search results 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. |