Interface | osid.voting.PollsSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getPolls | ||
Description |
Gets the polls list resulting from the search. | ||
Return | osid.voting.PollsList | the polls list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getPollsQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.voting.PollsQueryInspector | the polls query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getPollsSearchResultsRecord | ||
Description |
Gets the polls search results record corresponding to
the given polls search record | ||
Parameters | osid.type.Type | pollsSearchRecordType | a polls search record type |
Return | osid.voting.records.PollsSearchResultsRecord | the polls search results record | |
Errors | NULL_ARGUMENT | pollsSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(pollsSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |