public interface BallotSearch extends OsidSearch
The search interface for governing ballot searches.
Modifier and Type | Method and Description |
---|---|
BallotSearchRecord |
getBallotSearchRecord(Type ballotSearchRecordType)
Gets the ballot search record corresponding to the given ballot search
record
Type. |
void |
orderBallotResults(BallotSearchOrder ballotSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongBallots(IdList ballotIds)
Execute this search among the given list of ballots.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBallots(IdList ballotIds)
ballotIds
- list of ballot Ids
NullArgumentException
- ballotIds
is
null
mandatory
- This method must be implemented. void orderBallotResults(BallotSearchOrder ballotSearchOrder)
ballotSearchOrder
- ballot search orderNullArgumentException
- order
is
null
UnsupportedException
- order
is not of
this servicemandatory
- This method must be implemented. BallotSearchRecord getBallotSearchRecord(Type ballotSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.ballotSearchRecordType
- a ballot search record typeNullArgumentException
- ballotSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordTypeType(ballotSearchRecordType)
is
false
mandatory
- This method must be implemented.