org.osid.metering

Interface UtilitySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface UtilitySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
UtilityList	getUtilities() Gets the utility list resulting from a search.
UtilityQueryInspector	getUtilityQueryInspector() Gets the inspector for the query to examine the terms used in the search.
UtilitySearchResultsRecord	getUtilitySearchResultsRecord(Type utilitySearchRecordType) Gets the utility search results record corresponding to the given utility 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

getUtilities

UtilityList getUtilities()

Gets the utility list resulting from a search.

Returns:

the utility list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getUtilityQueryInspector

UtilityQueryInspector getUtilityQueryInspector()

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

Returns:

the utility query inspector

Compliance:

mandatory - This method must be implemented.

getUtilitySearchResultsRecord

UtilitySearchResultsRecord getUtilitySearchResultsRecord(Type utilitySearchRecordType)
                                                         throws OperationFailedException

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

Parameters:

utilitySearchRecordType - a utility search record type

Returns:

the utility search results record

Throws:

NullArgumentException - utilitySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(utilitySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.