public interface PollsSearch extends OsidSearch
The interface for governing polls searches.
Modifier and Type | Method and Description |
---|---|
PollsSearchRecord |
getPollsSearchRecord(Type pollsSearchRecordType)
Gets the polls search record corresponding to the given polls search
record
Type. |
void |
orderPollsResults(PollsSearchOrder pollsSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongPolls(IdList pollsIds)
Execute this search among the given list of polls.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongPolls(IdList pollsIds)
pollsIds
- list of pollsNullArgumentException
- pollsIds
is
null
mandatory
- This method must be implemented. void orderPollsResults(PollsSearchOrder pollsSearchOrder)
pollsSearchOrder
- polls search orderNullArgumentException
- pollsSearchOrder
is null
UnsupportedException
- pollsSearchOrder
is not of this servicemandatory
- This method must be implemented. PollsSearchRecord getPollsSearchRecord(Type pollsSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.pollsSearchRecordType
- a polls search record typeNullArgumentException
- pollsSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(pollsSearchRecordType)
is false
mandatory
- This method must be implemented.