org.osid.resourcing

Interface FoundryForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

FoundryBatchForm

public interface FoundryForm
extends OsidCatalogForm

This is the form for creating and updating foundries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the FoundryAdminSession. 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
FoundryFormRecord	getFoundryFormRecord(Type foundryRecordType) Gets the FoundryFormRecord corresponding to the given foundry 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

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getFoundryFormRecord

FoundryFormRecord getFoundryFormRecord(Type foundryRecordType)
                                       throws OperationFailedException

Gets the FoundryFormRecord corresponding to the given foundry record Type.

Parameters:

foundryRecordType - a foundry record type

Returns:

the foundry form record

Throws:

NullArgumentException - foundryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(foundryRecordType) is false

Compliance:

mandatory - This method must be implemented.