Interface VoteEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface VoteEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
VoteEnablerQueryInspector	getVoteEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
VoteEnablerList	getVoteEnablers()	Gets the vote enabler list resulting from a search.
VoteEnablerSearchResultsRecord	getVoteEnablerSearchResultsRecord(Type voteEnablerSearchRecordType)	Gets the vote enabler search results record corresponding to the given vote enabler 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

getVoteEnablers

VoteEnablerList getVoteEnablers()

Gets the vote enabler list resulting from a search.

Returns:

the vote enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getVoteEnablerQueryInspector

VoteEnablerQueryInspector getVoteEnablerQueryInspector()

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

Returns:

the vote enabler query inspector

Compliance:

mandatory - This method must be implemented.

getVoteEnablerSearchResultsRecord

VoteEnablerSearchResultsRecord getVoteEnablerSearchResultsRecord(Type voteEnablerSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

voteEnablerSearchRecordType - a vote enabler search record type

Returns:

the vote enabler search results record

Throws:

NullArgumentException - voteEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(voteEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.