Interface | osid.room.RoomForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
osid.OsidTemporalForm | |||
osid.OsidSubjugateableForm | |||
Description |
This is the form for creating and updating | ||
Method | getEnclosingRoomMetadata | ||
Description |
Gets the metadata for an enclosing room. | ||
Return | osid.Metadata | metadata for the enclosing room | |
Compliance | mandatory | This method must be implemented. | |
Method | setEnclosingRoom | ||
Description |
Sets the enclosing room. | ||
Parameters | osid.id.Id | roomId | the new enclosing room |
Errors | INVALID_ARGUMENT | roomId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | roomId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearEnclosingRoom | ||
Description |
Clears the enclosing room. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getDesignatedNameMetadata | ||
Description |
Gets the metadata for a designated name. | ||
Return | osid.Metadata | metadata for the designated name | |
Compliance | mandatory | This method must be implemented. | |
Method | setDesignatedName | ||
Description |
Sets the designated 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 | clearDesignatedName | ||
Description |
Clears the designated name. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCodeMetadata | ||
Description |
Gets the metadata for a code. | ||
Return | osid.Metadata | metadata for the code | |
Compliance | mandatory | This method must be implemented. | |
Method | setCode | ||
Description |
Sets the room code. | ||
Parameters | string | code | the new code |
Errors | INVALID_ARGUMENT | code is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | code is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCode | ||
Description |
Clears the room code. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getAreaMetadata | ||
Description |
Gets the metadata for the area. | ||
Return | osid.Metadata | metadata for the area | |
Compliance | mandatory | This method must be implemented. | |
Method | setArea | ||
Description |
Sets the area. | ||
Parameters | decimal | area | the new area |
Errors | INVALID_ARGUMENT | area is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | area is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearArea | ||
Description |
Clears the area. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getOccupancyLimitMetadata | ||
Description |
Gets the metadata for the room occupancy limit. | ||
Return | osid.Metadata | metadata for the area | |
Compliance | mandatory | This method must be implemented. | |
Method | setOccupancyLimit | ||
Description |
Sets the occupancy limit of the room. | ||
Parameters | cardinal | linit | the new linit |
Errors | INVALID_ARGUMENT | limit is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearOccupancyLimit | ||
Description |
Clears the occupancy limit. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourcesMetadata | ||
Description |
Gets the metadata for the room resources. | ||
Return | osid.Metadata | metadata for the resources | |
Compliance | mandatory | This method must be implemented. | |
Method | setResources | ||
Description |
Sets the resources. | ||
Parameters | osid.id.IdList | resourceIds | the new resources |
Errors | INVALID_ARGUMENT | resourceIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | resourceIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearResources | ||
Description |
Clears the resources. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoomFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | roomRecordType | the room record type |
Return | osid.room.records.RoomFormRecord | the room form 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. |