Interface | osid.voting.rules.BallotConstrainerSearchSession | ||
---|---|---|---|
Implements | osid.voting.rules.BallotConstrainerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getBallotConstrainerSearch | ||
Description |
Gets a ballot constrainer search. | ||
Return | osid.voting.rules.BallotConstrainerSearch | the ballot constrainer search | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotConstrainerSearchOrder | ||
Description |
Gets a ballot constrainer search order. The | ||
Return | osid.voting.rules.BallotConstrainerSearchOrder | the ballot constrainer search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotConstrainersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.voting.rules.BallotConstrainerQuery | ballotConstrainerQuery | the ballot constrainer query |
osid.voting.rules.BallotConstrainerSearch | ballotConstrainerSearch | the ballot constrainer search | |
Return | osid.voting.rules.BallotConstrainerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | ballotConstrainerQuery or ballotConstrainerSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | ballotConstrainerQuery or ballotConstrainerSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotConstrainerQueryFromInspector | ||
Description |
Gets a ballot constrainer query from an inspector. The
inspector is available from a | ||
Parameters | osid.voting.rules.BallotConstrainerQueryInspector | ballotConstrainerQueryInspector | a ballot constrainer query inspector |
Return | osid.voting.rules.BallotConstrainerQuery | the ballot constrainer query | |
Errors | NULL_ARGUMENT | ballotConstrainerQueryInspector is null | |
UNSUPPORTED | ballotConstrainerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |