OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.FloorLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Floor objects. The Floor represents a collection of rooms.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated campus view: All floor methods in this session operate, retrieve and pertain to floors defined explicitly in the current campus. Using an isolated view is useful for managing floors with the FloorAdminSession.
  • federated campus view: All floor lookup methods in this session operate, retrieve and pertain to all floors defined in this campus and any other campuses implicitly available in this campus through campus inheritence.
  • effective floor view: All floor lookup methods return effective floors.
  • any effective floor view: Floors of any effective date are returned.
MethodgetCampusId
Description

Gets the Campus Id associated with this session.

Returnosid.id.Idthe Campus Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCampus
Description

Gets the Campus associated with this session.

Returnosid.room.Campusthe campus
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupFloors
Description

Tests if this user can perform Floor lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeFloorView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryFloorView
Description

A complete view of the Floor returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedCampusView
Description

Federates the view for methods in this session. A federated view will include floors in campuses which are children of this campus in the campus hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCampusView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveFloorView
Description

Only floors whose effective dates are current are returned by methods in this session

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveFloorView
Description

Floors of any effective dates are returned by all methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetFloor
Description

Gets the Floor specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Floor may have a different Id than requested, such as the case where a duplicate Id was assigned to a Floor and retained for compatibility.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Parametersosid.id.IdfloorId Id of the Floor
Returnosid.room.Floorthe floor
ErrorsNOT_FOUND floorId not found
NULL_ARGUMENT floorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetFloorsByIds
Description

Gets a FloorList corresponding to the given IdList.

In plenary mode, the returned list contains all of the floors specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Floors may be omitted from the list and may present the elements in any order including returning a unique set.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Parametersosid.id.IdListfloorIdsthe list of Ids to retrieve
Returnosid.room.FloorListthe returned Floor list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT floorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFloorsByGenusType
Description

Gets a FloorList corresponding to the given floor genus Type which does not include floors of genus types derived from the specified Type.

In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Parametersosid.type.TypefloorGenusTypea floor genus type
Returnosid.room.FloorListthe returned Floor list
ErrorsNULL_ARGUMENT floorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFloorsByParentGenusType
Description

Gets a FloorList corresponding to the given floor genus Type and include any additional floors with genus types derived from the specified Type.

In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Parametersosid.type.TypefloorGenusTypea floor genus type
Returnosid.room.FloorListthe returned Floor list
ErrorsNULL_ARGUMENT floorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFloorsByRecordType
Description

Gets a FloorList containing the given floor record Type.

In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Parametersosid.type.TypefloorRecordTypea floor record type
Returnosid.room.FloorListthe returned Floor list
ErrorsNULL_ARGUMENT floorRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFloorsOnDate
Description

Gets a list of all floors effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.room.FloorListthe returned FloorList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFloorsForBuilding
Description

Gets a list of all floors corresponding to a building Id.

In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Parametersosid.id.IdbuildingIdthe Id of the building
Returnosid.room.FloorListthe returned FloorList
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFloorsForBuildingOnDate
Description

Gets a list of all floors corresponding to a building Id and effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Parametersosid.id.IdbuildingIda building Id
osid.calendaring.DateTimefromfrom date
osid.calendaring.DateTimetoto date
Returnosid.room.FloorListthe returned FloorList
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT buildingId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFloorsByNumber
Description

Gets a list of all floors of the given number.

In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Parametersstringnumbera floor number
Returnosid.room.FloorListthe returned FloorList
ErrorsNULL_ARGUMENT number is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFloors
Description

Gets all Floors.

In plenary mode, the returned list contains all known floors or an error results. Otherwise, the returned list may contain only those floors that are accessible through this session.

In effective mode, floors are returned that are currently effective. In any effective mode, effective floors and those currently expired are returned.

Returnosid.room.FloorLista list of Floors
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.