org.osid.metering

Interface UtilityQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

UtilitySearchSession

public interface UtilityQuerySession
extends OsidSession

This session provides methods for searching Utility objects. The search query is constructed using the UtilityQuery. The utility record Type also specifies the record for the utility query.

Utilities may have a query record indicated by their respective record types. The query record is accessed via the UtilityQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchUtilities() Tests if this user can perform Utility searches.
UtilityList	getUtilitiesByQuery(UtilityQuery utilityQuery) Gets a list of Utilities matching the given utility query.
UtilityQuery	getUtilityQuery() Gets a utility query.

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

canSearchUtilities

boolean canSearchUtilities()

Tests if this user can perform Utility searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getUtilityQuery

UtilityQuery getUtilityQuery()

Gets a utility query.

Returns:

the utility query

Compliance:

mandatory - This method must be implemented.

getUtilitiesByQuery

UtilityList getUtilitiesByQuery(UtilityQuery utilityQuery)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets a list of Utilities matching the given utility query.

Parameters:

utilityQuery - the utility query

Returns:

the returned UtilityList

Throws:

NullArgumentException - utilityQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - utilityQuery is not of this service

Compliance:

mandatory - This method must be implemented.