Interface BallotConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BallotConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BallotConstrainerQueryInspector	getBallotConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BallotConstrainerList	getBallotConstrainers()	Gets the BallotConstrainerList resulting from a search.
BallotConstrainerSearchResultsRecord	getBallotConstrainerSearchResultsRecord(Type ballotConstrainerSearchRecordType)	Gets the ballot constrainer search results record corresponding to the given ballot constrainer search record Type .This method must be 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

getBallotConstrainers

BallotConstrainerList getBallotConstrainers()

Gets the BallotConstrainerList resulting from a search.

Returns:

the ballot constrainer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBallotConstrainerQueryInspector

BallotConstrainerQueryInspector getBallotConstrainerQueryInspector()

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

Returns:

the ballot constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getBallotConstrainerSearchResultsRecord

BallotConstrainerSearchResultsRecord getBallotConstrainerSearchResultsRecord(Type ballotConstrainerSearchRecordType)
                                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

ballotConstrainerSearchRecordType - a ballot constrainer search record type

Returns:

the ballot constrainer search results record

Throws:

NullArgumentException - ballotConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(ballotConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.