Interface | osid.voting.BallotSearchSession | ||
---|---|---|---|
Implements | osid.voting.BallotQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Ballots may have a ballot query record indicated by their
respective record types. The ballot query record is accessed
via the | ||
Method | getBallotSearch | ||
Description |
Gets a ballot search. | ||
Return | osid.voting.BallotSearch | the ballot search | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotSearchOrder | ||
Description |
Gets a ballot search order. The | ||
Return | osid.voting.BallotSearchOrder | the ballot search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.voting.BallotQuery | ballotQuery | the ballot query |
osid.voting.BallotSearch | ballotSearch | the ballot search | |
Return | osid.voting.BallotSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | ballotQuery or ballotSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | ballotQuery or ballotSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotQueryFromInspector | ||
Description |
Gets a ballot query from an inspector. The inspector is
available from a | ||
Parameters | osid.voting.BallotQueryInspector | ballotQueryInspector | a ballot query inspector |
Return | osid.voting.BallotQuery | the ballot query | |
Errors | NULL_ARGUMENT | ballotQueryInspector is null | |
UNSUPPORTED | ballotQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |