OSID Logo
OSID Specifications
room package
Version 3.0.0
Interfaceosid.room.FloorForm
Implementsosid.OsidObjectForm
osid.OsidTemporalForm
osid.OsidSubjugateableForm
Implemented Byosid.room.batch.FloorBatchForm
Used Byosid.room.FloorAdminSession
Description

This is the form for creating and updating Floors . Like all OsidForms , 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_ARGUMENTnumber is invalid
NO_ACCESSMetadata.isReadOnly() is true
NULL_ARGUMENTnumber is null
CompliancemandatoryThis method must be implemented.
MethodclearNumber
Description

Clears the number.

ErrorsNO_ACCESSMetadata.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_ARGUMENTarea is invalid
NO_ACCESSMetadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearGrossArea
Description

Clears the area.

ErrorsNO_ACCESSMetadata.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_ARGUMENTfloorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(floorRecordType) is false
CompliancemandatoryThis method must be implemented.