org.osid.recipe

Interface ProcedureForm

All Superinterfaces:

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

All Known Subinterfaces:

ProcedureBatchForm

public interface ProcedureForm
extends OsidObjectForm

This is the form for creating and updating Procedure objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProcedureAdminSession. 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
ProcedureFormRecord	getProcedureFormRecord(Type procedureRecordType) Gets the ProcedureFormRecord corresponding to the given procedure 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

getProcedureFormRecord

ProcedureFormRecord getProcedureFormRecord(Type procedureRecordType)
                                           throws OperationFailedException

Gets the ProcedureFormRecord corresponding to the given procedure record Type.

Parameters:

procedureRecordType - the procedure record type

Returns:

the procedure form record

Throws:

NullArgumentException - procedureRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(procedureRecordType) is false

Compliance:

mandatory - This method must be implemented.