org.osid.mapping

Interface LocationForm

All Superinterfaces:

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

All Known Subinterfaces:

LocationBatchForm

public interface LocationForm
extends OsidObjectForm, OsidFederateableForm

This is the form for creating and updating Locations. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the LocationAdminSession. 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
void	clearSpatialUnit() Removes the spatial unit.
LocationFormRecord	getLocationFormRecord(Type locationRecordType) Gets the LocationFormRecord corresponding to the given location record Type.
Metadata	getSpatialUnitMetadata() Gets the metadata for a spatial unit.
void	setSpatialUnit(SpatialUnit spatialUnit) Sets the spatial unit.

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

getSpatialUnitMetadata

Metadata getSpatialUnitMetadata()

Gets the metadata for a spatial unit.

Returns:

metadata for the spatial unit

Compliance:

mandatory - This method must be implemented.

setSpatialUnit

void setSpatialUnit(SpatialUnit spatialUnit)

Sets the spatial unit.

Parameters:

spatialUnit - the new spatial unit

Throws:

InvalidArgumentException - spatialUnit is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - spatialUnit is null

UnsupportedException - spatialUnit type is not supported

Compliance:

mandatory - This method must be implemented.

clearSpatialUnit

void clearSpatialUnit()

Removes the spatial unit.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLocationFormRecord

LocationFormRecord getLocationFormRecord(Type locationRecordType)
                                         throws OperationFailedException

Gets the LocationFormRecord corresponding to the given location record Type.

Parameters:

locationRecordType - a location record type

Returns:

the location form record

Throws:

NullArgumentException - locationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(locationRecordType) is false

Compliance:

mandatory - This method must be implemented.