OSID Logo
OSID Specifications
room construction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.RenovationForm
Implementsosid.OsidObjectForm
osid.OsidTemporalForm
Description

This is the form for creating and updating Renovations. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RenovationAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetRoomsMetadata
Description

Gets the metadata for a set of rooms.

Returnosid.Metadatametadata for the rooms
CompliancemandatoryThis method must be implemented.
MethodsetRooms
Description

Sets the rooms.

Parametersosid.id.Id[]roomIdsthe new rooms
ErrorsINVALID_ARGUMENT roomIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT roomIds is null
CompliancemandatoryThis method must be implemented.
MethodclearRooms
Description

Clears the rooms.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCostMetadata
Description

Gets the metadata for the cost.

Returnosid.Metadatametadata for the cost
CompliancemandatoryThis method must be implemented.
MethodsetCost
Description

Sets the cost.

Parametersosid.financials.Currencycostthe new cost
ErrorsINVALID_ARGUMENT cost is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT cost is null
CompliancemandatoryThis method must be implemented.
MethodclearCost
Description

Clears the cost.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRenovationFormRecord
Description

Gets the RenovationFormRecord corresponding to the given renovation record Type.

Parametersosid.type.TyperenovationRecordTypethe renovation record type
Returnosid.room.construction.records.RenovationFormRecordthe renovation form record
ErrorsNULL_ARGUMENT renovationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(renovationRecordType) is false
CompliancemandatoryThis method must be implemented.