org.osid.voting.rules

Interface BallotConstrainerEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BallotConstrainerEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
BallotConstrainerEnablerQueryInspector	getBallotConstrainerEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
BallotConstrainerEnablerList	getBallotConstrainerEnablers() Gets the BallotConstrainerEnablerList resulting from a search.
BallotConstrainerEnablerSearchResultsRecord	getBallotConstrainerEnablerSearchResultsRecord(Type ballotConstrainerEnablerSearchRecordType) Gets the ballot constrainer enabler search results record corresponding to the given ballot constrainer enabler 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

getBallotConstrainerEnablers

BallotConstrainerEnablerList getBallotConstrainerEnablers()

Gets the BallotConstrainerEnablerList resulting from a search.

Returns:

the ballot constrainer enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBallotConstrainerEnablerQueryInspector

BallotConstrainerEnablerQueryInspector getBallotConstrainerEnablerQueryInspector()

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

Returns:

the ballot constrainer enabler query inspector

Compliance:

mandatory - This method must be implemented.

getBallotConstrainerEnablerSearchResultsRecord

BallotConstrainerEnablerSearchResultsRecord getBallotConstrainerEnablerSearchResultsRecord(Type ballotConstrainerEnablerSearchRecordType)
                                                                                           throws OperationFailedException,
                                                                                                  PermissionDeniedException

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

Parameters:

ballotConstrainerEnablerSearchRecordType - a ballot constrainer enabler search record type

Returns:

the ballot constrainer enabler search results record

Throws:

NullArgumentException - ballotConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(ballotConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.