Interface PriceEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PriceEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PriceEnablerQueryInspector	getPriceEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
PriceEnablerList	getPriceEnablers()	Gets the PriceEnablerList resulting from a search.
PriceEnablerSearchResultsRecord	getPriceEnablerSearchResultsRecord(Type priceEnablerSearchRecordType)	Gets the price enabler search results record corresponding to the given price 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

getPriceEnablers

PriceEnablerList getPriceEnablers()

Gets the PriceEnablerList resulting from a search.

Returns:

the price enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPriceEnablerQueryInspector

PriceEnablerQueryInspector getPriceEnablerQueryInspector()

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

Returns:

the price enabler query inspector

Compliance:

mandatory - This method must be implemented.

getPriceEnablerSearchResultsRecord

PriceEnablerSearchResultsRecord getPriceEnablerSearchResultsRecord(Type priceEnablerSearchRecordType)
                                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

priceEnablerSearchRecordType - a price enabler search record type

Returns:

the price enabler search results record

Throws:

NullArgumentException - priceEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(priceEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.