org.osid.room

Interface Building

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Temporal

public interface Building
extends OsidObject, Temporal

A Building represents a collection of floors.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getAddressId

Id getAddressId()

Gets the address of this building.

Returns:

the building address Id

Compliance:

mandatory - This method must be implemented.

getAddress

Address getAddress()
                   throws OperationFailedException

Gets the building address.

Returns:

the building address.

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getOfficialName

DisplayText getOfficialName()

Gets the formal name for this building (e.g. Guggenheim Laboratory). The display name may or may not differ from this name but may be based on the code (e.g. Building 35).

Returns:

the name

Compliance:

mandatory - This method must be implemented.

getNumber

java.lang.String getNumber()

Gets the building number or code (e.g. 35).

Returns:

the building number

Compliance:

mandatory - This method must be implemented.

isSubdivision

boolean isSubdivision()

Tests if this building is a subdivision of another building.

Returns:

true if this building is a subdivisiaion, false otherwise

Compliance:

mandatory - This method must be implemented.

getEnclosingBuildingId

Id getEnclosingBuildingId()

Gets the enclosing building Id if this building is a subdivision.

Returns:

the enclosing building Id

Throws:

IllegalStateException - isSubdivision() is false

Compliance:

mandatory - This method must be implemented.

getEnclosingBuilding

Building getEnclosingBuilding()
                              throws OperationFailedException

Gets the enclosing building if this building is a subdivision.

Returns:

the enlcosing building

Throws:

IllegalStateException - isSubdivision() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getSubdivisionIds

IdList getSubdivisionIds()

Gets the subdivision building Ids if this building is subdivided.

Returns:

the subdivision building Ids

Compliance:

mandatory - This method must be implemented.

getSubdivisions

BuildingList getSubdivisions()
                             throws OperationFailedException

Gets the subdivision buildings if this building is subdivided.

Returns:

the subdivision buildings

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasArea

boolean hasArea()

Tests if an area is available.

Returns:

true if an area is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGrossArea

java.math.BigDecimal getGrossArea()

Gets the gross square footage of this building.

Returns:

the gross area

Throws:

IllegalStateException - hasArea() is false

Compliance:

mandatory - This method must be implemented.

getBuildingRecord

BuildingRecord getBuildingRecord(Type buildingRecordType)
                                 throws OperationFailedException

Gets the building record corresponding to the given 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 .

Parameters:

buildingRecordType - the type of building record to retrieve

Returns:

the building record

Throws:

NullArgumentException - buildingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(buildingRecordType) is false

Compliance:

mandatory - This method must be implemented.