org.osid.metering

Interface UtilityLookupSession

All Superinterfaces:

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

public interface UtilityLookupSession
extends OsidSession

This session provides methods for retrieving Utility objects. The Utility represents a collection of meters.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Utilities it can access, without breaking execution. However, an assessment may only be useful if all Utilities referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupUtilities() Tests if this user can perform Utility lookups.
UtilityList	getUtilities() Gets all Utilities.
UtilityList	getUtilitiesByGenusType(Type utilityGenusType) Gets a UtilityList corresponding to the given utility genus Type which does not include utilities of genus types derived from the specified Type.
UtilityList	getUtilitiesByIds(IdList utilityIds) Gets a UtilityList corresponding to the given IdList.
UtilityList	getUtilitiesByParentGenusType(Type utilityGenusType) Gets a UtilityList corresponding to the given utility genus Type and include any additional utilities with genus types derived from the specified Type.
UtilityList	getUtilitiesByProvider(Id resourceId) Gets a UtilityList for the given provider .
UtilityList	getUtilitiesByRecordType(Type utilityRecordType) Gets a UtilityList containing the given utility record Type.
Utility	getUtility(Id utilityId) Gets the Utility specified by its Id.
void	useComparativeUtilityView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryUtilityView() A complete view of the Utility returns is desired.

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

canLookupUtilities

boolean canLookupUtilities()

Tests if this user can perform Utility lookups. 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 lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeUtilityView

void useComparativeUtilityView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryUtilityView

void usePlenaryUtilityView()

A complete view of the Utility returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getUtility

Utility getUtility(Id utilityId)
                   throws NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

Gets the Utility specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Utility may have a different Id than requested, such as the case where a duplicate Id was assigned to a Utility and retained for compatibility.

Parameters:

utilityId - Id of the Utility

Returns:

the utility

Throws:

NotFoundException - utilityId not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getUtilitiesByIds

UtilityList getUtilitiesByIds(IdList utilityIds)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets a UtilityList corresponding to the given IdList. In plenary mode, the returned list contains all of the utilities specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Utilities may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

utilityIds - the list of Ids to retrieve

Returns:

the returned Utility list

Throws:

NotFoundException - an Id was not found

NullArgumentException - utilityIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUtilitiesByGenusType

UtilityList getUtilitiesByGenusType(Type utilityGenusType)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a UtilityList corresponding to the given utility genus Type which does not include utilities of genus types derived from the specified Type. In plenary mode, the returned list contains all known utilities or an error results. Otherwise, the returned list may contain only those utilities that are accessible through this session.

Parameters:

utilityGenusType - a utility genus type

Returns:

the returned Utility list

Throws:

NullArgumentException - utilityGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUtilitiesByParentGenusType

UtilityList getUtilitiesByParentGenusType(Type utilityGenusType)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a UtilityList corresponding to the given utility genus Type and include any additional utilities with genus types derived from the specified Type. In plenary mode, the returned list contains all known utilities or an error results. Otherwise, the returned list may contain only those utilities that are accessible through this session.

Parameters:

utilityGenusType - a utility genus type

Returns:

the returned Utility list

Throws:

NullArgumentException - utilityGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUtilitiesByRecordType

UtilityList getUtilitiesByRecordType(Type utilityRecordType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a UtilityList containing the given utility record Type. In plenary mode, the returned list contains all known utilities or an error results. Otherwise, the returned list may contain only those utilities that are accessible through this session.

Parameters:

utilityRecordType - a utility record type

Returns:

the returned Utility list

Throws:

NullArgumentException - utilityRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUtilitiesByProvider

UtilityList getUtilitiesByProvider(Id resourceId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a UtilityList for the given provider . In plenary mode, the returned list contains all known utilities or an error results. Otherwise, the returned list may contain only those utilities that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Utility list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUtilities

UtilityList getUtilities()
                         throws OperationFailedException,
                                PermissionDeniedException

Gets all Utilities. In plenary mode, the returned list contains all known utilities or an error results. Otherwise, the returned list may contain only those utilities that are accessible through this session.

Returns:

a list of Utilities

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.