Room
A Room.
Like all OsidObjects,
Room is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| Name | Syntax | Many | Description |
|---|---|---|---|
buildingId |
id | the building Id |
|
building |
Building | the building | |
floorId |
id | the floor Id |
|
floor |
Floor | the floor | |
isSubdivision |
boolean | true if this room is a subdivisiaion, false
otherwise |
|
enclosingRoomId |
id | the enclosing room Id |
|
enclosingRoom |
Room | the enlcosing room | |
subdivisionIds |
id | ⋆ | the subdivision room Ids |
subdivisions |
Room | ⋆ | the subdivision rooms |
designatedName |
displaytext | the room number | |
roomNumber |
string | the room number | |
code |
string | the room code | |
hasArea |
boolean | true if an area is available, false otherwise |
|
area |
decimal | the area in square feet | |
occupancyLimit |
cardinal | the occupancy limit | |
resourceIds |
id | ⋆ | the resource Ids |
resources |
Resource | ⋆ | a list of resources |
Floor
A Floor represents a collection of
rooms with a Building.
Like all OsidObjects,
Floor is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
Building
A Building represents a collection of
floors.
Like all OsidObjects,
Building is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| Name | Syntax | Many | Description |
|---|---|---|---|
addressId |
id | the building address Id |
|
address |
Address | the building address. | |
officialName |
displaytext | the name | |
number |
string | the building number | |
isSubdivision |
boolean | true if this building is a subdivisiaion, false
otherwise |
|
enclosingBuildingId |
id | the enclosing building Id |
|
enclosingBuilding |
Building | the enlcosing building | |
subdivisionIds |
id | ⋆ | the subdivision building Ids |
subdivisions |
Building | ⋆ | the subdivision buildings |
hasArea |
boolean | true if an area is available, false otherwise |
|
grossArea |
decimal | the gross area |
Campus
A Campus represents a collection of
rooms. Like all OSID objects, a Campus is
identified by its Id and any persisted
references should use the Id.
Like all OsidObjects,
Campus is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Sourceable | |||
providerId |
id | the provider Id |
|
provider |
Resource | the provider | |
brandingIds |
id | ⋆ | a list of asset Ids |
branding |
Asset | ⋆ | a list of assets |
license |
displaytext | the license | |