org.osid.control

Interface DeviceForm

All Superinterfaces:

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

All Known Subinterfaces:

DeviceBatchForm

public interface DeviceForm
extends OsidObjectForm

This is the form for creating and updating Devices. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the DeviceAdminSession. 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
DeviceFormRecord	getDeviceFormRecord(Type deviceRecordType) Gets the DeviceFormRecord corresponding to the given device 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

getDeviceFormRecord

DeviceFormRecord getDeviceFormRecord(Type deviceRecordType)
                                     throws OperationFailedException

Gets the DeviceFormRecord corresponding to the given device record Type.

Parameters:

deviceRecordType - a device record type

Returns:

the device form record

Throws:

NullArgumentException - deviceRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deviceRecordType) is false

Compliance:

mandatory - This method must be implemented.