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

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

MethodgetEnclosingRoomMetadata
Description

Gets the metadata for an enclosing room.

Returnosid.Metadatametadata for the enclosing room
CompliancemandatoryThis method must be implemented.
MethodsetEnclosingRoom
Description

Sets the enclosing room.

Parametersosid.id.IdroomIdthe new enclosing room
ErrorsINVALID_ARGUMENT roomId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT roomId is null
CompliancemandatoryThis method must be implemented.
MethodclearEnclosingRoom
Description

Clears the enclosing room.

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

Gets the metadata for a designated name.

Returnosid.Metadatametadata for the designated name
CompliancemandatoryThis method must be implemented.
MethodsetDesignatedName
Description

Sets the designated name.

Parametersstringnamethe new name
ErrorsINVALID_ARGUMENT name is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT name is null
CompliancemandatoryThis method must be implemented.
MethodclearDesignatedName
Description

Clears the designated name.

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

Gets the metadata for a code.

Returnosid.Metadatametadata for the code
CompliancemandatoryThis method must be implemented.
MethodsetCode
Description

Sets the room code.

Parametersstringcodethe new code
ErrorsINVALID_ARGUMENT code is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT code is null
CompliancemandatoryThis method must be implemented.
MethodclearCode
Description

Clears the room code.

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

Gets the metadata for the area.

Returnosid.Metadatametadata for the area
CompliancemandatoryThis method must be implemented.
MethodsetArea
Description

Sets the area.

Parametersdecimalareathe new area
ErrorsINVALID_ARGUMENT area is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT area is null
CompliancemandatoryThis method must be implemented.
MethodclearArea
Description

Clears the area.

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

Gets the metadata for the room occupancy limit.

Returnosid.Metadatametadata for the area
CompliancemandatoryThis method must be implemented.
MethodsetOccupancyLimit
Description

Sets the occupancy limit of the room.

Parameterscardinallinitthe new linit
ErrorsINVALID_ARGUMENT limit is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearOccupancyLimit
Description

Clears the occupancy limit.

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

Gets the metadata for the room resources.

Returnosid.Metadatametadata for the resources
CompliancemandatoryThis method must be implemented.
MethodsetResources
Description

Sets the resources.

Parametersosid.id.IdListresourceIdsthe new resources
ErrorsINVALID_ARGUMENT resourceIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceIds is null
CompliancemandatoryThis method must be implemented.
MethodclearResources
Description

Clears the resources.

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

Gets the RoomFormRecord corresponding to the given room record Type.

Parametersosid.type.TyperoomRecordTypethe room record type
Returnosid.room.records.RoomFormRecordthe room form record
ErrorsNULL_ARGUMENT roomRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(roomRecordType) is false
CompliancemandatoryThis method must be implemented.