Interface BallotSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BallotSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
BallotQueryInspector	getBallotQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BallotList	getBallots()	Gets the ballot list resulting from a search.
BallotSearchResultsRecord	getBallotSearchResultsRecord(Type ballotSearchRecordType)	Gets the ballot search results record corresponding to the given ballot search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getBallots

BallotList getBallots()

Gets the ballot list resulting from a search.

Returns:

the ballot list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getBallotQueryInspector

BallotQueryInspector getBallotQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the ballot query inspector

Compliance:

mandatory - This method must be implemented.

getBallotSearchResultsRecord

BallotSearchResultsRecord getBallotSearchResultsRecord(Type ballotSearchRecordType)
                                                throws OperationFailedException

Gets the ballot search results record corresponding to the given ballot search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

ballotSearchRecordType - a ballot search record type

Returns:

the ballot search results record

Throws:

NullArgumentException - ballotSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(ballotSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.