org.osid.metering

Interface UtilityForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

UtilityBatchForm

public interface UtilityForm
extends OsidCatalogForm

This is the form for creating and updating utilities. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the UtilityAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
UtilityFormRecord	getUtilityFormRecord(Type utilityRecordType) Gets the UtilityFormRecord corresponding to the given utility record Type.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getUtilityFormRecord

UtilityFormRecord getUtilityFormRecord(Type utilityRecordType)
                                       throws OperationFailedException

Gets the UtilityFormRecord corresponding to the given utility record Type.

Parameters:

utilityRecordType - the utility record type

Returns:

the utility form record

Throws:

NullArgumentException - utilityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(utilityRecordType) is false

Compliance:

mandatory - This method must be implemented.