OSID - osid.room.Building Service Interface Definition

Interface	osid.room.Building
Implements	`osid.OsidObject`
Implements	`osid.Temporal`
Description	A `Building` represents a collection of floors.
Method	getAddressId
Description	Gets the address of this building.
Return	`osid.id.Id`		the building address `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getAddress
Description	Gets the building address.
Return	`osid.contact.Address`		the building address.
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getOfficialName
Description	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).
Return	`osid.locale.DisplayText`		the name
Compliance	`mandatory`		This method must be implemented.
Method	getNumber
Description	Gets the building number or code (e.g. 35).
Return	`string`		the building number
Compliance	`mandatory`		This method must be implemented.
Method	isSubdivision
Description	Tests if this building is a subdivision of another building.
Return	`boolean`		`true` if this building is a subdivisiaion, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEnclosingBuildingId
Description	Gets the enclosing building `Id` if this building is a subdivision.
Return	`osid.id.Id`		the enclosing building `Id`
Errors	ILLEGAL_STATE		`isSubdivision()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getEnclosingBuilding
Description	Gets the enclosing building if this building is a subdivision.
Return	`osid.room.Building`		the enlcosing building
Errors	ILLEGAL_STATE		`isSubdivision()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSubdivisionIds
Description	Gets the subdivision building `Ids` if this building is subdivided.
Return	`osid.id.IdList`		the subdivision building `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getSubdivisions
Description	Gets the subdivision buildings if this building is subdivided.
Return	`osid.room.BuildingList`		the subdivision buildings
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasArea
Description	Tests if an area is available.
Return	`boolean`		`true` if an area is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGrossArea
Description	Gets the gross square footage of this building.
Return	`decimal`		the gross area
Errors	ILLEGAL_STATE		`hasArea()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingRecord
Description	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	`osid.type.Type`	`buildingRecordType`	the type of building record to retrieve
Return	`osid.room.records.BuildingRecord`		the building record
Errors	NULL_ARGUMENT		`buildingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(buildingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.