Interface | osid.voting.PollsSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The interface for governing polls searches. | ||
Method | searchAmongPolls | ||
Description |
Execute this search among the given list of polls. | ||
Parameters | osid.id.IdList | pollsIds | list of polls |
Errors | NULL_ARGUMENT | pollsIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderPollsResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.voting.PollsSearchOrder | pollsSearchOrder | polls search order |
Errors | NULL_ARGUMENT | pollsSearchOrder is null | |
UNSUPPORTED | pollsSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPollsSearchRecord | ||
Description |
Gets the polls search record corresponding to the given
polls search record | ||
Parameters | osid.type.Type | pollsSearchRecordType | a polls search record type |
Return | osid.voting.records.PollsSearchRecord | the polls search 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. |