org.osid.control

Interface InputForm

All Superinterfaces:

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

All Known Subinterfaces:

InputBatchForm

public interface InputForm
extends OsidRuleForm

This is the form for creating and updating Inputs. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the InputAdminSession. 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
InputFormRecord	getInputFormRecord(Type inputRecordType) Gets the InputFormRecord corresponding to the given input record Type.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

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.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getInputFormRecord

InputFormRecord getInputFormRecord(Type inputRecordType)
                                   throws OperationFailedException

Gets the InputFormRecord corresponding to the given input record Type.

Parameters:

inputRecordType - an input record type

Returns:

the input form record

Throws:

NullArgumentException - inputRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputRecordType) is false

Compliance:

mandatory - This method must be implemented.