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

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

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.