Interface | osid.voting.CandidateSearchSession | ||
---|---|---|---|
Implements | osid.voting.CandidateQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Candidates may have a candidiate query record indicated by
their respective record types. The candidiate query record is
accessed via the | ||
Method | getCandidateSearch | ||
Description |
Gets a candidate search. | ||
Return | osid.voting.CandidateSearch | the candidate search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCandidateSearchOrder | ||
Description |
Gets a candidate search order. The | ||
Return | osid.voting.CandidateSearchOrder | the candidate search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCandidatesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.voting.CandidateQuery | candidateQuery | the candidate query |
osid.voting.CandidateSearch | candidateSearch | the candidate search | |
Return | osid.voting.CandidateSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | candidateQuery or candidateSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | candidateQuery or candidateSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCandidateQueryFromInspector | ||
Description |
Gets a candidate query from an inspector. The inspector
is available from a | ||
Parameters | osid.voting.CandidateQueryInspector | candidateQueryInspector | a candidate query inspector |
Return | osid.voting.CandidateQuery | the candidate query | |
Errors | NULL_ARGUMENT | candidateQueryInspector is null | |
UNSUPPORTED | candidateQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |