public interface Building extends OsidObject, Temporal
A Building
represents a collection of floors.
Modifier and Type | Method and Description |
---|---|
Address |
getAddress()
Gets the building address.
|
Id |
getAddressId()
Gets the address of this building.
|
BuildingRecord |
getBuildingRecord(Type buildingRecordType)
Gets the building record corresponding to the given
Building
record Type. |
Building |
getEnclosingBuilding()
Gets the enclosing building if this building is a subdivision.
|
Id |
getEnclosingBuildingId()
Gets the enclosing building
Id if this building is a
subdivision. |
java.math.BigDecimal |
getGrossArea()
Gets the gross square footage of this building.
|
java.lang.String |
getNumber()
Gets the building number or code (e.g.
|
DisplayText |
getOfficialName()
Gets the formal name for this building (e.g.
|
IdList |
getSubdivisionIds()
Gets the subdivision building
Ids if this building is
subdivided. |
BuildingList |
getSubdivisions()
Gets the subdivision buildings if this building is subdivided.
|
boolean |
hasArea()
Tests if an area is available.
|
boolean |
isSubdivision()
Tests if this building is a subdivision of another building.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getAddressId()
Id
mandatory
- This method must be implemented. Address getAddress() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DisplayText getOfficialName()
mandatory
- This method must be implemented. java.lang.String getNumber()
mandatory
- This method must be implemented. boolean isSubdivision()
true
if this building is a subdivisiaion,
false
otherwisemandatory
- This method must be implemented. Id getEnclosingBuildingId()
Id
if this building is a
subdivision. Id
IllegalStateException
- isSubdivision()
is false
mandatory
- This method must be implemented. Building getEnclosingBuilding() throws OperationFailedException
IllegalStateException
- isSubdivision()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getSubdivisionIds()
Ids
if this building is
subdivided. Ids
mandatory
- This method must be implemented. BuildingList getSubdivisions() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasArea()
true
if an area is available, false
otherwisemandatory
- This method must be implemented. java.math.BigDecimal getGrossArea()
IllegalStateException
- hasArea()
is
false
mandatory
- This method must be implemented. BuildingRecord getBuildingRecord(Type buildingRecordType) throws OperationFailedException
Building
record Type.
This method is used to retrieve an
object implementing the requested record. The
buildingRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(buildingRecordType)
is true
.buildingRecordType
- the type of building record to retrieveNullArgumentException
- buildingRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(buildingRecordType)
is false
mandatory
- This method must be implemented.