public interface DeedCampusSession extends OsidSession
This session provides methods to retrieve Deed
to
Campus
mappings. A Deed
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 |
canLookupDeedCampusMappings()
Tests if this user can perform lookups of deed/campus mappings.
|
CampusList |
getCampusesByDeed(Id deedId)
Gets the list of
Campus objects mapped to a
Deed. |
IdList |
getCampusIdsByDeed(Id deedId)
Gets the list of
Campus Ids mapped to a
Deed. |
IdList |
getDeedIdsByCampus(Id campusId)
Gets the list of
Deed Ids associated
with a Campus. |
IdList |
getDeedIdsByCampuses(IdList campusIds)
Gets the list of
Deed Ids corresponding to a list of
Campus objects. |
DeedList |
getDeedsByCampus(Id campusId)
Gets the list of
Deeds associated with a Campus. |
DeedList |
getDeedsByCampuses(IdList campusIds)
Gets the list of
Deeds 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
Deed and Campus
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupDeedCampusMappings()
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()
Deed
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 getDeedIdsByCampus(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Deed
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. DeedList getDeedsByCampus(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Deeds
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 getDeedIdsByCampuses(IdList campusIds) throws OperationFailedException, PermissionDeniedException
Deed 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. DeedList getDeedsByCampuses(IdList campusIds) throws OperationFailedException, PermissionDeniedException
Deeds
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 getCampusIdsByDeed(Id deedId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Campus
Ids
mapped to a
Deed.
deedId
- Id
of a Deed
Ids
NotFoundException
- deedId
is not foundNullArgumentException
- deedId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CampusList getCampusesByDeed(Id deedId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Campus
objects mapped to a
Deed.
deedId
- Id
of a Deed
NotFoundException
- deedId
is not foundNullArgumentException
- deedId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.