org.osid.metering

Interface MeterSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MeterQuerySession, OsidSession

public interface MeterSearchSession
extends MeterQuerySession

This session provides methods for searching among meters. The search query is constructed using the MeterQuery.

getMetersByQuery() is the basic search method and returns a list of meters. A more advanced search may be performed with getMetersBySearch(). It accepts a MeterSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getMetersBySearch() returns a MeterSearchResults that can be used to access the resulting MeterList or be used to perform a search within the result set through MeterSearch.

This session defines views that offer differing behaviors for searching.

• federated utility view: searches include meters in utilities of which this utility is an ancestor in the utility hierarchy
• isolated utility view: searches are restricted to meters in this utility only

Method Summary

Methods

Modifier and Type	Method and Description
MeterQuery	getMeterQueryFromInspector(MeterQueryInspector meterQueryInspector) Gets a meter query from an inspector.
MeterSearchResults	getMetersBySearch(MeterQuery meterQuery, MeterSearch meterSearch) Gets the search results matching the given search query using the given search.
MeterSearch	getMeterSearch() Gets a meter search.
MeterSearchOrder	getMeterSearchOrder() Gets a meter search order.

Methods inherited from interface org.osid.metering.MeterQuerySession

canSearchMeters, getMeterQuery, getMetersByQuery, getUtility, getUtilityId, useFederatedUtilityView, useIsolatedUtilityView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getMeterSearch

MeterSearch getMeterSearch()

Gets a meter search.

Returns:

the meter search

Compliance:

mandatory - This method must be implemented.

getMeterSearchOrder

MeterSearchOrder getMeterSearchOrder()

Gets a meter search order. The MeterSearchOrder is supplied to a MeterSearch to specify the ordering of results.

Returns:

the meter search order

Compliance:

mandatory - This method must be implemented.

getMetersBySearch

MeterSearchResults getMetersBySearch(MeterQuery meterQuery,
                                   MeterSearch meterSearch)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

meterQuery - the meter query

meterSearch - the meter search

Returns:

the returned search results

Throws:

NullArgumentException - meterQuery or meterSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - meterQuery or meterSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getMeterQueryFromInspector

MeterQuery getMeterQueryFromInspector(MeterQueryInspector meterQueryInspector)

Gets a meter query from an inspector. The inspector is available from a MeterSearchResults.

Parameters:

meterQueryInspector - a meter query inspector

Returns:

the meter query

Throws:

NullArgumentException - meterQueryInspector is null

UnsupportedException - meterQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.