| Interface | osid.voting.rules.VoteEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.voting.rules.VoteEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getVoteEnablers | ||
| Description |
Gets the vote enabler list resulting from a search. | ||
| Return | osid.voting.rules.VoteEnablerList | the vote enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVoteEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.voting.rules.VoteEnablerQueryInspector | the vote enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVoteEnablerSearchResultsRecord | ||
| Description |
Gets the vote enabler search results record
corresponding to the given vote enabler search record
| ||
| Parameters | osid.type.Type | voteEnablerSearchRecordType | a vote enabler search record type |
| Return | osid.voting.rules.records.VoteEnablerSearchResultsRecord | the vote enabler search results record | |
| Errors | NULL_ARGUMENT | voteEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(voteEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |