org.osid.mapping

Interface MapForm

All Superinterfaces:

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

All Known Subinterfaces:

MapBatchForm

public interface MapForm
extends OsidCatalogForm

This is the form for creating and updating maps. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the MapAdminSession. 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
MapFormRecord	getMapFormRecord(Type mapRecordType) Gets the MapFormRecord interface corresponding to the given map record interface 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

getMapFormRecord

MapFormRecord getMapFormRecord(Type mapRecordType)
                               throws OperationFailedException

Gets the MapFormRecord interface corresponding to the given map record interface Type.

Parameters:

mapRecordType - a map record type

Returns:

the map form record

Throws:

NullArgumentException - mapRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mapRecordType) is false

Compliance:

mandatory - This method must be implemented.