Interface | osid.voting.BallotSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getBallots | ||
Description |
Gets the ballot list resulting from a search. | ||
Return | osid.voting.BallotList | the ballot list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.voting.BallotQueryInspector | the ballot query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotSearchResultsRecord | ||
Description |
Gets the ballot search results record corresponding to
the given ballot search record | ||
Parameters | osid.type.Type | ballotSearchRecordType | a ballot search record type |
Return | osid.voting.records.BallotSearchResultsRecord | the ballot search results record | |
Errors | NULL_ARGUMENT | ballotSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordTypeType(ballotSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |