public interface RoomLookupSession extends OsidSession
This session defines methods for retrieving rooms.
This lookup session defines several views:
RoomAdminSession.
The methods useFederatedCampusView()
and
useIsolatedCampusView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRooms()
Tests if this user can lookup rooms.
|
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
Room |
getRoom(Id roomId)
Gets the
Room specified by its Id. |
RoomList |
getRooms()
Gets all rooms.
|
RoomList |
getRoomsByGenusType(Type roomGenusType)
Gets a
RoomList corresponding to the given room genus
Type which does not include rooms of genus types
derived from the specified Type. |
RoomList |
getRoomsByGenusTypeForBuilding(Id buildingId,
Type roomGenusType)
Gets a list of all rooms of the given genus type corresponding to a
building
Id. |
RoomList |
getRoomsByGenusTypeForBuildingOnDate(Id buildingId,
Type roomGenusType,
DateTime from,
DateTime to)
Gets a list of all rooms of the given genus type corresponding to a
building
Id and effective during the entire given date
range inclusive but not confined to the date range. |
RoomList |
getRoomsByGenusTypeForFloor(Id floorId,
Type roomGenusType)
Gets a list of all rooms of the given genus type corresponding to a
floor
Id. |
RoomList |
getRoomsByGenusTypeForFloorOnDate(Id floorId,
Type roomGenusType,
DateTime from,
DateTime to)
Gets a list of all rooms of the given genus type corresponding to a
floor
Id and effective during the entire given date
range inclusive but not confined to the date range. |
RoomList |
getRoomsByGenusTypeOnDate(Type roomGenusType,
DateTime from,
DateTime to)
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.
|
RoomList |
getRoomsByIds(IdList roomIds)
Gets a
RoomList corresponding to the given
IdList. |
RoomList |
getRoomsByParentGenusType(Type roomGenusType)
Gets a
RoomList corresponding to the given room genus
Type and include any additional rooms with genus types
derived from the specified Type. |
RoomList |
getRoomsByRecordType(Type roomRecordType)
Gets a
RoomList containing the given room record
Type. |
RoomList |
getRoomsByRoomNumber(java.lang.String number)
Gets a list of all rooms of the given room number.
|
RoomList |
getRoomsForBuilding(Id buildingId)
Gets a list of all rooms corresponding to a building
Id. |
RoomList |
getRoomsForBuildingOnDate(Id buildingId,
DateTime from,
DateTime to)
Gets a list of all rooms corresponding to a building
Id
and effective during the entire given date range inclusive but not
confined to the date range. |
RoomList |
getRoomsForFloor(Id floorId)
Gets a list of all rooms corresponding to a floor
Id. |
RoomList |
getRoomsForFloorOnDate(Id floorId,
DateTime from,
DateTime to)
Gets a list of all rooms corresponding to a floor
Id
and effective during the entire given date range inclusive but not
confined to the date range. |
RoomList |
getRoomsOnDate(DateTime from,
DateTime to)
Gets a list of all rooms effective during the entire given date range
inclusive but not confined to the date range.
|
void |
useAnyEffectiveRoomView()
Rooms of any effective dates are returned by all methods in this
session.
|
void |
useComparativeRoomView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useEffectiveRoomView()
Only rooms whose effective dates are current are returned by methods
in this session
|
void |
useFederatedCampusView()
Federates the view for methods in this session.
|
void |
useIsolatedCampusView()
Isolates the view for methods in this session.
|
void |
usePlenaryRoomView()
A complete view of the
Room returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCampusId()
Campus
Id
associated with this
session. Campus Id
associated with this sessionmandatory
- This method must be implemented. Campus getCampus() throws OperationFailedException, PermissionDeniedException
Campus
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRooms()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations. false
if room lookup methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeRoomView()
mandatory
- This method is must be implemented. void usePlenaryRoomView()
Room
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.mandatory
- This method is must be implemented. void useFederatedCampusView()
mandatory
- This method is must be implemented. void useIsolatedCampusView()
mandatory
- This method is must be implemented. void useEffectiveRoomView()
mandatory
- This method is must be implemented. void useAnyEffectiveRoomView()
mandatory
- This method is must be implemented. Room getRoom(Id roomId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Room
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Room
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Room
and retained for compatibility.
In effective mode, rooms are returned that are currently effective. In
any effective mode, effective rooms and those currently expired are
returned.roomId
- the Id
of the Room
to
retrieve Room
NotFoundException
- no Room
found with
the given Id
NullArgumentException
- roomId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByIds(IdList roomIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
RoomList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
rooms 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 rooms may be omitted from the list and may present the
elements in any order including returning a unique set.
In effective mode, rooms are returned that are currently effective. In
any effective mode, effective rooms and those currently expired are
returned.roomIds
- the list of Ids
to retrieve Room list
NotFoundException
- an Id
was not foundNullArgumentException
- roomIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByGenusType(Type roomGenusType) throws OperationFailedException, PermissionDeniedException
RoomList
corresponding to the given room genus
Type
which does not include rooms of genus types
derived from the specified Type.
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.roomGenusType
- a room genus type Room
listNullArgumentException
- roomGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByParentGenusType(Type roomGenusType) throws OperationFailedException, PermissionDeniedException
RoomList
corresponding to the given room genus
Type
and include any additional rooms with genus types
derived from the specified Type.
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.roomGenusType
- a room genus type Rooms
listNullArgumentException
- roomGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByRecordType(Type roomRecordType) throws OperationFailedException, PermissionDeniedException
RoomList
containing the given room record
Type.
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.roomRecordType
- a room record type Rooms
listNullArgumentException
- roomRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.from
- start of date rangeto
- end of date range RoomList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByGenusTypeOnDate(Type roomGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
roomGenusType
- a room genus Type
from
- start of date rangeto
- end of date range RoomList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- roomGenusType, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
Id.
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.buildingId
- the Id
of the building RoomList
NullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsForBuildingOnDate(Id buildingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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 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.buildingId
- a building Id
from
- from dateto
- to date RoomList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- buildingId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByGenusTypeForBuilding(Id buildingId, Type roomGenusType) throws OperationFailedException, PermissionDeniedException
Id.
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.buildingId
- the Id
of the buildingroomGenusType
- a room genus type RoomList
NullArgumentException
- buildingId
or
roomGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByGenusTypeForBuildingOnDate(Id buildingId, Type roomGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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 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.buildingId
- a building Id
roomGenusType
- a room genus typefrom
- from dateto
- to date RoomList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- buildingId,
roomGenusType, from,
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsForFloor(Id floorId) throws OperationFailedException, PermissionDeniedException
Id.
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.floorId
- the Id
of the building RoomList
NullArgumentException
- floorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsForFloorOnDate(Id floorId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and effective during the entire given date range inclusive but not
confined to the date range.
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.floorId
- a building Id
from
- from dateto
- to date RoomList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- floorId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByGenusTypeForFloor(Id floorId, Type roomGenusType) throws OperationFailedException, PermissionDeniedException
Id.
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.floorId
- the Id
of the floorroomGenusType
- a room genus type RoomList
NullArgumentException
- floorId
or
roomGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByGenusTypeForFloorOnDate(Id floorId, Type roomGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and effective during the entire given date
range inclusive but not confined to the date range.
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.floorId
- a floor Id
roomGenusType
- a room genus typefrom
- from dateto
- to date RoomList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- floorId, roomGenusType,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByRoomNumber(java.lang.String number) throws OperationFailedException, PermissionDeniedException
number
- a room number RoomList
NullArgumentException
- number
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRooms() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.