public interface RenovationCampusSession extends OsidSession
This session provides methods to retrieve Renovation
to
Campus
mappings. A Renovation
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 |
canLookupRenovationCampusMappings()
Tests if this user can perform lookups of renovation/campus mappings.
|
CampusList |
getCampusesByRenovation(Id renovationId)
Gets the list of
Campus objects mapped to a
Renovation. |
IdList |
getCampusIdsByRenovation(Id renovationId)
Gets the list of
Campus Ids mapped to a
Renovation. |
IdList |
getRenovationIdsByCampus(Id campusId)
Gets the list of
Renovation Ids
associated with a Campus. |
IdList |
getRenovationIdsByCampuses(IdList campusIds)
Gets the list of
Renovation Ids corresponding to a list
of Campus objects. |
RenovationList |
getRenovationsByCampus(Id campusId)
Gets the list of
Renovations associated with a
Campus. |
RenovationList |
getRenovationsByCampuses(IdList campusIds)
Gets the list of
Renovations 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
Renovation and Campus
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRenovationCampusMappings()
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()
Renovation
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 getRenovationIdsByCampus(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Renovation
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. RenovationList getRenovationsByCampus(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Renovations
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 getRenovationIdsByCampuses(IdList campusIds) throws OperationFailedException, PermissionDeniedException
Renovation 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. RenovationList getRenovationsByCampuses(IdList campusIds) throws OperationFailedException, PermissionDeniedException
Renovations
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 getCampusIdsByRenovation(Id renovationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Campus
Ids
mapped to a
Renovation.
renovationId
- Id
of a Renovation
Ids
NotFoundException
- renovationId
is not
foundNullArgumentException
- renovationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CampusList getCampusesByRenovation(Id renovationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Campus
objects mapped to a
Renovation.
renovationId
- Id
of a Renovation
NotFoundException
- renovationId
is not
foundNullArgumentException
- renovationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.