org.osid.room

Interface Summary
Interface	Description
Building	A `Building` represents a collection of floors.
BuildingAdminSession	This session creates, updates, and deletes `Buildings.`
BuildingCampusAssignmentSession	This session provides methods to re-assign `Buildings` to `Campuses.`
BuildingCampusSession	This session provides methods to retrieve `Building` to `Campus` mappings.
BuildingForm	This is the form for creating and updating `Buildings.`
BuildingList	Like all `OsidLists,` `BuildingList` provides a means for accessing `Building` elements sequentially either one at a time or many at a time.
BuildingLookupSession	This session provides methods for retrieving `Building` objects.
BuildingNotificationSession	This session defines methods to receive notifications on adds/changes to `Building` objects.
BuildingQuery	This is the query for searching for buildings.
BuildingQueryInspector	This is the query inspector for examining for building queries.
BuildingQuerySession	This session provides methods for searching `Building` objects.
BuildingReceiver	The building receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Building` objects.
BuildingSearch	The search interface for governing building searches.
BuildingSearchOrder	An interface for specifying the ordering of search results.
BuildingSearchResults	This interface provides a means to capture results of a search.
BuildingSearchSession	This session provides methods for searching `Building` objects.
BuildingSmartCampusSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Campus	A `Campus` represents a collection of rooms.
CampusAdminSession	This session creates and removes campuses.
CampusForm	This is the form for creating and updating `Campuses.`
CampusHierarchyDesignSession	This session manages a hierarchy of campuses.
CampusHierarchySession	This session defines methods for traversing a hierarchy of `Campus` objects.
CampusList	Like all `OsidLists,` `CampusList` provides a means for accessing `Campus` elements sequentially either one at a time or many at a time.
CampusLookupSession	This session provides methods for retrieving `Campus` objects.
CampusNode	This interface is a container for a partial hierarchy retrieval.
CampusNodeList	Like all `OsidLists,` `CampusNodeList` provides a means for accessing `CampusNode` elements sequentially either one at a time or many at a time.
CampusNotificationSession	This session defines methods to receive notifications on adds/changes to `Campus` objects.
CampusQuery	This is the query for searching for campuses.
CampusQueryInspector	This is the query inspector for examining for campus queries.
CampusQuerySession	This session provides methods for searching `Campus` objects.
CampusReceiver	The campus receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Campus` objects.
CampusSearch	The search interface for governing campus searches.
CampusSearchOrder	An interface for specifying the ordering of search results.
CampusSearchResults	This interface provides a means to capture results of a search.
CampusSearchSession	This session provides methods for searching `Campus` objects.
Floor	A `Floor` represents a collection of rooms with a `Building.`
FloorAdminSession	This session creates, updates, and deletes `Floors.`
FloorCampusAssignmentSession	This session provides methods to re-assign `Floors` to `Campuses.`
FloorCampusSession	This session provides methods to retrieve `Floor` to `Campus` mappings.
FloorForm	This is the form for creating and updating `Floors.`
FloorList	Like all `OsidLists,` `FloorList` provides a means for accessing `Floor` elements sequentially either one at a time or many at a time.
FloorLookupSession	This session provides methods for retrieving `Floor` objects.
FloorNotificationSession	This session defines methods to receive notifications on adds/changes to `Floor` objects.
FloorQuery	This is the query for searching for floors.
FloorQueryInspector	This is the query inspector for examining for floor queries.
FloorQuerySession	This session provides methods for searching `Floor` objects.
FloorReceiver	The floor receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Floor` objects.
FloorSearch	The search interface for governing floor searches.
FloorSearchOrder	An interface for specifying the ordering of search results.
FloorSearchResults	This interface provides a means to capture results of a search.
FloorSearchSession	This session provides methods for searching `Floor` objects.
FloorSmartCampusSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Room	A `Room.`
RoomAdminSession	This session creates, updates, and deletes `Rooms.`
RoomCampusAssignmentSession	This session provides methods to re-assign `Rooms` to `Campuses.`
RoomCampusSession	This session provides methods to retrieve `Room` to `Campus` mappings.
RoomForm	This is the form for creating and updating `Room` objects.
RoomList	Like all `OsidLists,` `RoomList` provides a means for accessing `Room` elements sequentially either one at a time or many at a time.
RoomLookupSession	This session defines methods for retrieving rooms.
RoomManager	The room manager provides access to room sessions and provides interoperability tests for various aspects of this service.
RoomNotificationSession	This session defines methods to receive notifications on adds/changes to `Room` objects.
RoomProfile	The room profile describes the interoperability among room services.
RoomProxyManager	The room manager provides access to room sessions and provides interoperability tests for various aspects of this service.
RoomQuery	This is the query for searching rooms.
RoomQueryInspector	The query inspector for examining room queries.
RoomQuerySession	This session provides methods for searching `Room` objects.
RoomReceiver	The room receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted rooms.
RoomSearch	The search interface for governing room searches.
RoomSearchOrder	An interface for specifying the ordering of search results.
RoomSearchResults	This interface provides a means to capture results of a search.
RoomSearchSession	This session provides methods for searching `Room` objects.
RoomSmartCampusSession	This session manages queries and sequencing to create "smart" dynamic catalogs.

Package org.osid.room Description

The Open Service Interface Definitions for the org.osid.room service.

The Room OSID provides a service for space accounting.

Rooms

A Room is an identifiable space on a Floor. A room genus Type may indicate the primary type of a Room, such as a classroom, an office, or a condo. Rooms may have subdivisions, as in the Gran Ballrrom may be partitioned into Ballroom-A and Ballroom-B.

Rooms may also have fixed Resources such as projectors and refridgerators. These Resources represent classes of equipment of interest when searching for rooms. Specific inventory management can be performed in the Inventory OSID.

Floors

A Floor contains a set of Rooms within a Building.

Buildings

Buildings have an Address and may be subdivided into smaller buildings. For example, Building 14 includes buildings 14E and 14N.

Contact Orchestration

Room, Floors, or Buildings may have contact information for a variety of purposes including ownership, scheduling, and maintenance. These contact relationships can be performed by orchestrating the Contact OSID.

Mapping & Resources

The Room OSID provides more detailed management the space accounting than what is capable from the more abtrsact Resource or Mapping OSIDs. Rooms, Floors or Buildings in the Room OSID may appear by way of Resources or Locations in other OSIDs.

In addition to defining abstract Locations, the Mapping OSID manages geospatial information of Locations using Coordinate and SpatialUnits. To manage geospatial information with respect to the Room OSID, the Mapping OSID can be orchestrated by mapping Rooms, Floors, and Buildings to Locations.

Campus Cataloging

Rooms, Floors, and Buildings may be organized into federateable OsidCatalogs of Campuses.

Sub Packages

The Room OSID includes a Room Squatting OSID for relating owners or users of rooms, a Room Construction OSID for tracking construction of and within buildings. and a Room Batch OSID for performing bulk operations.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.