org.osid.room

Interface FloorForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

FloorBatchForm

public interface FloorForm
extends OsidObjectForm, OsidTemporalForm, OsidSubjugateableForm

This is the form for creating and updating Floors. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the FloorAdminSession. 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	clearGrossArea() Clears the area.
void	clearNumber() Clears the number.
FloorFormRecord	getFloorFormRecord(Type floorRecordType) Gets the FloorFormRecord corresponding to the given floor record Type.
Metadata	getGrossAreaMetadata() Gets the metadata for the gross area.
Metadata	getNumberMetadata() Gets the metadata for a number.
void	setGrossArea(java.math.BigDecimal area) Sets the gross area.
void	setNumber(java.lang.String number) Sets the building number.

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.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getNumberMetadata

Metadata getNumberMetadata()

Gets the metadata for a number.

Returns:

metadata for the number

Compliance:

mandatory - This method must be implemented.

setNumber

void setNumber(java.lang.String number)

Sets the building number.

Parameters:

number - the new number

Throws:

InvalidArgumentException - number is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - number is null

Compliance:

mandatory - This method must be implemented.

clearNumber

void clearNumber()

Clears the number.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getGrossAreaMetadata

Metadata getGrossAreaMetadata()

Gets the metadata for the gross area.

Returns:

metadata for the area

Compliance:

mandatory - This method must be implemented.

setGrossArea

void setGrossArea(java.math.BigDecimal area)

Sets the gross area.

Parameters:

area - the new area

Throws:

InvalidArgumentException - area is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearGrossArea

void clearGrossArea()

Clears the area.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getFloorFormRecord

FloorFormRecord getFloorFormRecord(Type floorRecordType)
                                   throws OperationFailedException

Gets the FloorFormRecord corresponding to the given floor record Type.

Parameters:

floorRecordType - the floor record type

Returns:

the floor form record

Throws:

NullArgumentException - floorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(floorRecordType) is false

Compliance:

mandatory - This method must be implemented.