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 OsidForms, 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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

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.