| Interface | osid.room.FloorForm | ||
|---|---|---|---|
| Implements | osid.OsidObjectForm | ||
osid.OsidTemporalForm | |||
osid.OsidSubjugateableForm | |||
| Description |
This is the form for creating and updating | ||
| Method | getNumberMetadata | ||
| Description |
Gets the metadata for a number. | ||
| Return | osid.Metadata | metadata for the number | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setNumber | ||
| Description |
Sets the building number. | ||
| Parameters | string | number | the new number |
| Errors | INVALID_ARGUMENT | number is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| NULL_ARGUMENT | number is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearNumber | ||
| Description |
Clears the number. | ||
| Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGrossAreaMetadata | ||
| Description |
Gets the metadata for the gross area. | ||
| Return | osid.Metadata | metadata for the area | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setGrossArea | ||
| Description |
Sets the gross area. | ||
| Parameters | decimal | area | the new area |
| Errors | INVALID_ARGUMENT | area is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearGrossArea | ||
| Description |
Clears the area. | ||
| Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFloorFormRecord | ||
| Description |
Gets the | ||
| Parameters | osid.type.Type | floorRecordType | the floor record type |
| Return | osid.room.records.FloorFormRecord | the floor form record | |
| Errors | NULL_ARGUMENT | floorRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(floorRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |