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.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getSpatialUnitMetadata()
mandatory
- This method must be implemented. void setSpatialUnit(SpatialUnit spatialUnit)
spatialUnit
- the new spatial unitInvalidArgumentException
- spatialUnit
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- spatialUnit
is
null
UnsupportedException
- spatialUnit
type
is not supportedmandatory
- This method must be implemented. void clearSpatialUnit()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. LocationFormRecord getLocationFormRecord(Type locationRecordType) throws OperationFailedException
LocationFormRecord
corresponding to the given
location record Type.
locationRecordType
- a location record typeNullArgumentException
- locationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(locationRecordType)
is false
mandatory
- This method must be implemented.