public interface RoomCampusSession extends OsidSession
This session provides methods to retrieve Room
to
Campus
mappings. A Room
may appear in multiple
Campuses.
Each Campus
may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRoomCampusMappings()
Tests if this user can perform lookups of room/campus mappings.
|
CampusList |
getCampusesByRoom(Id roomId)
Gets the list of
Campus objects mapped to a
Room. |
IdList |
getCampusIdsByRoom(Id roomId)
Gets the list of
Campus Ids mapped to a
Room. |
IdList |
getRoomIdsByCampus(Id campusId)
Gets the list of
Room Ids associated
with a Campus. |
IdList |
getRoomIdsByCampuses(IdList campusIds)
Gets the list of
Room Ids corresponding to a list of
Campus objects. |
RoomList |
getRoomsByCampus(Id campusId)
Gets the list of
Rooms associated with a Campus. |
RoomList |
getRoomsByCampuses(IdList campusIds)
Gets the list of
Rooms corresponding to a list of
Campuses. |
void |
useComparativeCampusView()
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 |
usePlenaryCampusView()
A complete view of the
Room and Campus
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRoomCampusMappings()
PERMISSION_DENIED.
This is intendedas
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCampusView()
mandatory
- This method is must be implemented. void usePlenaryCampusView()
Room
and Campus
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. IdList getRoomIdsByCampus(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Room
Ids
associated
with a Campus.
campusId
- Id
of a Room
Ids
NotFoundException
- campusId
is not
foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByCampus(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Rooms
associated with a Campus.
campusId
- Id
of a Room
NotFoundException
- campusId
is not
foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRoomIdsByCampuses(IdList campusIds) throws OperationFailedException, PermissionDeniedException
Room Ids
corresponding to a list of
Campus
objects.campusIds
- list of campus Ids
Ids
NullArgumentException
- campusIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RoomList getRoomsByCampuses(IdList campusIds) throws OperationFailedException, PermissionDeniedException
Rooms
corresponding to a list of
Campuses.
campusIds
- list of campus Ids
NullArgumentException
- campusIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCampusIdsByRoom(Id roomId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Campus
Ids
mapped to a
Room.
roomId
- Id
of a Room
Ids
NotFoundException
- roomId
is not foundNullArgumentException
- roomId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CampusList getCampusesByRoom(Id roomId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Campus
objects mapped to a
Room.
roomId
- Id
of a Room
NotFoundException
- roomId
is not foundNullArgumentException
- roomId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.