OSID - osid.room.Room Service Interface Definition

Interface	osid.room.Room
Implements	`osid.OsidObject`
	`osid.Temporal`
	`osid.Subjugateable`
Description	A `Room.`
Method	getBuildingId
Description	Gets the `Id` of the building.
Return	`osid.id.Id`		the building `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getBuilding
Description	Gets the building.
Return	`osid.room.Building`		the building
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getFloorId
Description	Gets the floor `Id.`
Return	`osid.id.Id`		the floor `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getFloor
Description	Gets the floor.
Return	`osid.room.Floor`		the floor
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isSubdivision
Description	Tests if this room is a subdivision of another room.
Return	`boolean`		`true` if this room is a subdivisiaion, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEnclosingRoomId
Description	Gets the enclosing room `Id` if this room is a subdivision.
Return	`osid.id.Id`		the enclosing room `Id`
Errors	ILLEGAL_STATE		`isSubdivision()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getEnclosingRoom
Description	Gets the enclosing room if this room is a subdivision.
Return	`osid.room.Room`		the enlcosing room
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 room `Ids` if this room is subdivided.
Return	`osid.id.IdList`		the subdivision room `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getSubdivisions
Description	Gets the subdivision rooms if this room is subdivided.
Return	`osid.room.RoomList`		the subdivision rooms
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDesignatedName
Description	Gets the designated or formal name of the room (e.g. Twenty Chimneys). The display name may be mapped to this designated name, room number, or some other room label.
Return	`osid.locale.DisplayText`		the room number
Compliance	`mandatory`		This method must be implemented.
Method	getRoomNumber
Description	Gets the complete room number including the building and floor (e.g. W20-306).
Return	`string`		the room number
Compliance	`mandatory`		This method must be implemented.
Method	getCode
Description	Gets the room number within a floor (e.g. 06).
Return	`string`		the room code
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	getArea
Description	Gets the area of this room in square feet.
Return	`decimal`		the area in square feet
Errors	ILLEGAL_STATE		`hasArea()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getOccupancyLimit
Description	Gets the limit on occupancy of this room.
Return	`cardinal`		the occupancy limit
Compliance	`mandatory`		This method must be implemented.
Method	getResourceIds
Description	Gets the `Ids` of any resources in this room such as projectors, white boards, or other classes of equiptment.
Return	`osid.id.IdList`		the resource `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getResources
Description	Gets a list of resources in this room such as projectors, white boards, or other classes of equiptment. These classes of equipment are expressed as resources although they may be managed at the individual item level in the Inventory OSID. These resources are to facilitate searches among equipped rooms.
Return	`osid.resource.ResourceList`		a list of resources
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRoomRecord
Description	Gets the room record corresponding to the given `Room` record `Type.` This method is used to retrieve an object implementing the requested record. The `roomRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(roomRecordType)` is `true` .
Parameters	`osid.type.Type`	`roomRecordType`	the type of room record to retrieve
Return	`osid.room.records.RoomRecord`		the room record
Errors	NULL_ARGUMENT		`roomRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(roomRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.