OSID - osid.room.BuildingForm Service Interface Definition

Interface	osid.room.BuildingForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidTemporalForm`
Implemented By	`osid.room.batch.BuildingBatchForm`
Used By	`osid.room.BuildingAdminSession`
Description	This is the form for creating and updating `Buildings`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `BuildingAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getAddressMetadata
Description	Gets the metadata for an address.
Return	`osid.Metadata`		metadata for the address
Compliance	`mandatory`		This method must be implemented.
Method	setAddress
Description	Sets the address.
Parameters	`osid.id.Id`	`addressId`	the new address
Errors	INVALID_ARGUMENT		`addressId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`addressId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAddress
Description	Clears the address.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getOfficialNameMetadata
Description	Gets the metadata for an official name.
Return	`osid.Metadata`		metadata for the official name
Compliance	`mandatory`		This method must be implemented.
Method	setOfficialName
Description	Sets the official name.
Parameters	`string`	`name`	the new name
Errors	INVALID_ARGUMENT		`name` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`name` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOfficialName
Description	Clears the official name.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
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 building number.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEnclosingBuildingMetadata
Description	Gets the metadata for an enclosing building.
Return	`osid.Metadata`		metadata for the enclosing building
Compliance	`mandatory`		This method must be implemented.
Method	setEnclosingBuilding
Description	Sets the enclosing building.
Parameters	`osid.id.Id`	`buildingId`	the new enclosing building
Errors	INVALID_ARGUMENT		`buildingId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`buildingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEnclosingBuilding
Description	Clears the enclosing building.
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
Errors	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	getBuildingFormRecord
Description	Gets the `BuildingFormRecord` corresponding to the given building record `Type`.
Parameters	`osid.type.Type`	`buildingRecordType`	the building record type
Return	`osid.room.records.BuildingFormRecord`		the building form 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.