org.osid.voting.rules

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

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.