org.osid.metering

Interface MeterForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

MeterBatchForm

public interface MeterForm
extends OsidObjectForm

This is the form for creating and updating Meters. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the MeterAdminSession. 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
MeterFormRecord	getMeterFormRecord(Type meterRecordType) Gets the MeterFormRecord corresponding to the given Meter 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

Method Detail

getMeterFormRecord

MeterFormRecord getMeterFormRecord(Type meterRecordType)
                                   throws OperationFailedException

Gets the MeterFormRecord corresponding to the given Meter record Type.

Parameters:

meterRecordType - the meter record type

Returns:

the meter form record

Throws:

NullArgumentException - meterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(meterRecordType) is false

Compliance:

mandatory - This method must be implemented.