Interface | osid.room.RoomLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving rooms. This lookup session defines several views:
The methods | ||
Method | getCampusId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Campus Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCampus | ||
Description |
Gets the | ||
Return | osid.room.Campus | the campus | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupRooms | ||
Description |
Tests if this user can lookup rooms. 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 | ||
Return | boolean | false if room lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeRoomView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryRoomView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCampusView | ||
Description |
Federates the view for methods in this session. A federated view will include rooms in campuses which are children of this campus in the campus hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCampusView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveRoomView | ||
Description |
Only rooms whose effective dates are current are returned by methods in this session | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveRoomView | ||
Description |
Rooms of any effective dates are returned by all methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRoom | ||
Description |
Gets the In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.Id | roomId | the Id of the Room to retrieve |
Return | osid.room.Room | the returned Room | |
Errors | NOT_FOUND | no Room found with the given Id | |
NULL_ARGUMENT | roomId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByIds | ||
Description |
Gets a In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.IdList | roomIds | the list of Ids to retrieve |
Return | osid.room.RoomList | the returned Room list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | roomIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByGenusType | ||
Description |
Gets a In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.type.Type | roomGenusType | a room genus type |
Return | osid.room.RoomList | the returned Room list | |
Errors | NULL_ARGUMENT | roomGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByParentGenusType | ||
Description |
Gets a In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.type.Type | roomGenusType | a room genus type |
Return | osid.room.RoomList | the returned Rooms list | |
Errors | NULL_ARGUMENT | roomGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByRecordType | ||
Description |
Gets a In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.type.Type | roomRecordType | a room record type |
Return | osid.room.RoomList | the returned Rooms list | |
Errors | NULL_ARGUMENT | roomRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsOnDate | ||
Description |
Gets a list of all rooms effective during the entire
given date range inclusive but not confined to the date
range. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.RoomList | the returned RoomList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByGenusTypeOnDate | ||
Description |
Gets a list of all rooms of a genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.type.Type | roomGenusType | a room genus Type |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.RoomList | the returned RoomList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | roomGenusType, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsForBuilding | ||
Description |
Gets a list of all rooms corresponding to a building
In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.Id | buildingId | the Id of the building |
Return | osid.room.RoomList | the returned RoomList | |
Errors | NULL_ARGUMENT | buildingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsForBuildingOnDate | ||
Description |
Gets a list of all rooms corresponding to a building
In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.Id | buildingId | a building Id |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.room.RoomList | the returned RoomList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | buildingId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByGenusTypeForBuilding | ||
Description |
Gets a list of all rooms of the given genus type
corresponding to a building In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.Id | buildingId | the Id of the building |
osid.type.Type | roomGenusType | a room genus type | |
Return | osid.room.RoomList | the returned RoomList | |
Errors | NULL_ARGUMENT | buildingId or roomGenusType is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByGenusTypeForBuildingOnDate | ||
Description |
Gets a list of all rooms of the given genus type
corresponding to a building In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.Id | buildingId | a building Id |
osid.type.Type | roomGenusType | a room genus type | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.room.RoomList | the returned RoomList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | buildingId, roomGenusType, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsForFloor | ||
Description |
Gets a list of all rooms corresponding to a floor
In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.Id | floorId | the Id of the building |
Return | osid.room.RoomList | the returned RoomList | |
Errors | NULL_ARGUMENT | floorId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsForFloorOnDate | ||
Description |
Gets a list of all rooms corresponding to a floor
Rooms are returned with start effective dates that fall between the requested dates inclusive. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.Id | floorId | a building Id |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.room.RoomList | the returned RoomList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | floorId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByGenusTypeForFloor | ||
Description |
Gets a list of all rooms of the given genus type
corresponding to a floor In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.Id | floorId | the Id of the floor |
osid.type.Type | roomGenusType | a room genus type | |
Return | osid.room.RoomList | the returned RoomList | |
Errors | NULL_ARGUMENT | floorId or roomGenusType is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByGenusTypeForFloorOnDate | ||
Description |
Gets a list of all rooms of the given genus type
corresponding to a floor Rooms are returned with start effective dates that fall between the requested dates inclusive. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | osid.id.Id | floorId | a floor Id |
osid.type.Type | roomGenusType | a room genus type | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.room.RoomList | the returned RoomList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | floorId, roomGenusType, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsByRoomNumber | ||
Description |
Gets a list of all rooms of the given room number. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Parameters | string | number | a room number |
Return | osid.room.RoomList | the returned RoomList | |
Errors | NULL_ARGUMENT | number is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRooms | ||
Description |
Gets all rooms. In plenary mode, the returned list contains all known rooms or an error results. Otherwise, the returned list may contain only those rooms that are accessible through this session. In effective mode, rooms are returned that are currently effective. In any effective mode, effective rooms and those currently expired are returned. | ||
Return | osid.room.RoomList | a list of rooms | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |