org.osid.process

Interface StateForm

All Superinterfaces:

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

public interface StateForm
extends OsidObjectForm

This is the form for creating and updating States. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the StateAdminSession. 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
StateFormRecord	getStateFormRecord(Type stateRecordType) Gets the StateFormRecord corresponding to the given State 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

getStateFormRecord

StateFormRecord getStateFormRecord(Type stateRecordType)
                                   throws OperationFailedException

Gets the StateFormRecord corresponding to the given State record Type.

Parameters:

stateRecordType - the state record type

Returns:

the record

Throws:

NullArgumentException - stateRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stateRecordType) is false

Compliance:

mandatory - This method must be implemented.