public interface Utility extends OsidCatalog
A Utility
represents a collection of Meters.
Like all OSID objects, a Utility
is identified by
its Id and any persisted references should use the Id.
Modifier and Type | Method and Description |
---|---|
UtilityRecord |
getUtilityRecord(Type utilityRecordType)
Gets the utility record corresponding to the given
Utility
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
UtilityRecord getUtilityRecord(Type utilityRecordType) throws OperationFailedException
Utility
record Type.
This method is used to retrieve an
object implementing the requested record. The utilityRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(utilityRecordType)
is true
.utilityRecordType
- the type of utility record to retrieveNullArgumentException
- utilityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(utilityRecordType)
is false
mandatory
- This method must be implemented.