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.
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.
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupUtilities()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeUtilityView()
mandatory
- This method is must be implemented. void usePlenaryUtilityView()
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.mandatory
- This method is must be implemented. Utility getUtility(Id utilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.utilityId
- Id
of the Utility
NotFoundException
- utilityId
not foundNullArgumentException
- utilityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. UtilityList getUtilitiesByIds(IdList utilityIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.utilityIds
- the list of Ids
to retrieve Utility
listNotFoundException
- an Id was
not foundNullArgumentException
- utilityIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UtilityList getUtilitiesByGenusType(Type utilityGenusType) throws OperationFailedException, PermissionDeniedException
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.utilityGenusType
- a utility genus type Utility
listNullArgumentException
- utilityGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UtilityList getUtilitiesByParentGenusType(Type utilityGenusType) throws OperationFailedException, PermissionDeniedException
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.utilityGenusType
- a utility genus type Utility
listNullArgumentException
- utilityGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UtilityList getUtilitiesByRecordType(Type utilityRecordType) throws OperationFailedException, PermissionDeniedException
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.utilityRecordType
- a utility record type Utility
listNullArgumentException
- utilityRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UtilityList getUtilitiesByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
Utility
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UtilityList getUtilities() throws OperationFailedException, PermissionDeniedException
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. Utilities
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.