OSID Logo
OSID Specifications
room construction package
Version 3.1.0
Interfaceosid.room.construction.Renovation
Implementsosid.OsidObject
osid.Temporal
Used Byosid.room.construction.RenovationAdminSession
osid.room.construction.RenovationList
osid.room.construction.RenovationLookupSession
Description

A Renovation represents a construction project within a building.

MethodgetRoomIds
Description

Gets the Id of the affected rooms.

Returnosid.id.IdList the room Id
Compliancemandatory This method must be implemented.
MethodgetRooms
Description

Gets the affected rooms.

Returnosid.room.RoomList the rooms
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodhasCost
Description

Tests if this renovation has a cost.

Returnboolean true if a cost is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetCost
Description

Gets the cost for this renovation.

Returnosid.financials.Currency the cost
ErrorsILLEGAL_STATE hasCost() is false
Compliancemandatory This method must be implemented.
MethodgetRenovationRecord
Description

Gets the renovation record corresponding to the given Renovation record Type. This method is used to retrieve an object implementing the requested record. The renovationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(renovationRecordType) is true.

Parametersosid.type.TyperenovationRecordType the type of renovation record to retrieve
Returnosid.room.construction.records.RenovationRecord the renovation record
ErrorsNULL_ARGUMENT renovationRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(renovationRecordType) is false
Compliancemandatory This method must be implemented.