public interface BuildingCampusSession extends OsidSession
This session provides methods to retrieve Building
to
Campus
mappings. A Building
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 |
canLookupBuildingCampusMappings()
Tests if this user can perform lookups of building/campus mappings.
|
IdList |
getBuildingIdsByCampus(Id campusId)
Gets the list of
Building Ids associated
with a Campus. |
IdList |
getBuildingIdsByCampuses(IdList campusIds)
Gets the list of
Building Ids corresponding to a list
of Campus objects. |
BuildingList |
getBuildingsByCampus(Id campusId)
Gets the list of
Buildings associated with a
Campus. |
BuildingList |
getBuildingsByCampuses(IdList campusIds)
Gets the list of
Buildings corresponding to a list of
Campuses. |
CampusList |
getCampusesByBuilding(Id buildingId)
Gets the list of
Campus objects mapped to a
Building. |
IdList |
getCampusIdsByBuilding(Id buildingId)
Gets the list of
Campus Ids mapped to a
Building. |
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
Building and Campus
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBuildingCampusMappings()
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()
Building
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 getBuildingIdsByCampus(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Building
Ids
associated
with a Campus.
campusId
- Id
of a Campus
Ids
NotFoundException
- campusId
is not
foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BuildingList getBuildingsByCampus(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Buildings
associated with a
Campus.
campusId
- Id
of a Campus
NotFoundException
- campusId
is not
foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBuildingIdsByCampuses(IdList campusIds) throws OperationFailedException, PermissionDeniedException
Building 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. BuildingList getBuildingsByCampuses(IdList campusIds) throws OperationFailedException, PermissionDeniedException
Buildings
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 getCampusIdsByBuilding(Id buildingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Campus
Ids
mapped to a
Building.
buildingId
- Id
of a Building
Ids
NotFoundException
- buildingId
is not
foundNullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CampusList getCampusesByBuilding(Id buildingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Campus
objects mapped to a
Building.
buildingId
- Id
of a Building
NotFoundException
- buildingId
is not
foundNullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.