OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.FloorForm
Implementsosid.OsidObjectForm
osid.OsidTemporalForm
osid.OsidSubjugateableForm
Description

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.

MethodgetNumberMetadata
Description

Gets the metadata for a number.

Returnosid.Metadatametadata for the number
CompliancemandatoryThis method must be implemented.
MethodsetNumber
Description

Sets the building number.

Parametersstringnumberthe new number
ErrorsINVALID_ARGUMENT number is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT number is null
CompliancemandatoryThis method must be implemented.
MethodclearNumber
Description

Clears the number.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetGrossAreaMetadata
Description

Gets the metadata for the gross area.

Returnosid.Metadatametadata for the area
CompliancemandatoryThis method must be implemented.
MethodsetGrossArea
Description

Sets the gross area.

Parametersdecimalareathe new area
ErrorsINVALID_ARGUMENT area is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearGrossArea
Description

Clears the area.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetFloorFormRecord
Description

Gets the FloorFormRecord corresponding to the given floor record Type.

Parametersosid.type.TypefloorRecordTypethe floor record type
Returnosid.room.records.FloorFormRecordthe floor form record
ErrorsNULL_ARGUMENT floorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(floorRecordType) is false
CompliancemandatoryThis method must be implemented.