| Interface | osid.room.construction.RenovationForm | ||
|---|---|---|---|
| Implements | osid.OsidObjectForm | ||
osid.OsidTemporalForm | |||
| Description |
This is the form for creating and updating | ||
| Method | getRoomsMetadata | ||
| Description |
Gets the metadata for a set of rooms. | ||
| Return | osid.Metadata | metadata for the rooms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setRooms | ||
| Description |
Sets the rooms. | ||
| Parameters | osid.id.Id[] | roomIds | the new rooms |
| Errors | INVALID_ARGUMENT | roomIds is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| NULL_ARGUMENT | roomIds is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearRooms | ||
| Description |
Clears the rooms. | ||
| Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCostMetadata | ||
| Description |
Gets the metadata for the cost. | ||
| Return | osid.Metadata | metadata for the cost | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setCost | ||
| Description |
Sets the cost. | ||
| Parameters | osid.financials.Currency | cost | the new cost |
| Errors | INVALID_ARGUMENT | cost is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| NULL_ARGUMENT | cost is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearCost | ||
| Description |
Clears the cost. | ||
| Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRenovationFormRecord | ||
| Description |
Gets the | ||
| Parameters | osid.type.Type | renovationRecordType | the renovation record type |
| Return | osid.room.construction.records.RenovationFormRecord | the renovation form record | |
| Errors | NULL_ARGUMENT | renovationRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(renovationRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |