public interface ConferralAcademySession extends OsidSession
This session provides methods to retrieve Conferral
to
Academy
mappings. A Conferral
may appear in
multiple Academies.
Each Academy
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 |
canLookupConferralAcademyMappings()
Tests if this user can perform lookups of conferral/academy mappings.
|
AcademyList |
getAcademiesByConferral(Id conferralId)
Gets the list of
Academy objects mapped to a
Conferral. |
IdList |
getAcademyIdsByConferral(Id conferralId)
Gets the list of
Academy Ids mapped to a
Conferral. |
IdList |
getConferralIdsByAcademies(IdList academyIds)
Gets the list of
Conferral Ids corresponding to a list
of Academy objects. |
IdList |
getConferralIdsByAcademy(Id academyId)
Gets the list of Conferral Ids associated with an
Academy. |
ConferralList |
getConferralsByAcademies(IdList academyIds)
Gets the list of
Conferrals corresponding to a list of
Academies. |
ConferralList |
getConferralsByAcademy(Id academyId)
Gets the list of
Conferrals associated with an
Academy. |
void |
useComparativeAcademyView()
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 |
usePlenaryAcademyView()
A complete view of the
Conferral and Academy
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupConferralAcademyMappings()
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 useComparativeAcademyView()
mandatory
- This method is must be implemented. void usePlenaryAcademyView()
Conferral
and Academy
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 getConferralIdsByAcademy(Id academyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Academy.
academyId
- Id
of an Academy.
Ids
NotFoundException
- academyId
is not
foundNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByAcademy(Id academyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Conferrals
associated with an
Academy.
academyId
- Id
of an Academy
NotFoundException
- academyId
is not
foundNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getConferralIdsByAcademies(IdList academyIds) throws OperationFailedException, PermissionDeniedException
Conferral Ids
corresponding to a list
of Academy
objects.academyIds
- list of academy Ids
Ids
NullArgumentException
- academyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByAcademies(IdList academyIds) throws OperationFailedException, PermissionDeniedException
Conferrals
corresponding to a list of
Academies.
academyIds
- list of academy Ids
NullArgumentException
- academyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAcademyIdsByConferral(Id conferralId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Academy
Ids
mapped to a
Conferral.
conferralId
- Id
of a Conferral
Ids
NotFoundException
- conferralId
is not
foundNullArgumentException
- conferralId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AcademyList getAcademiesByConferral(Id conferralId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Academy
objects mapped to a
Conferral.
conferralId
- Id
of a Conferral
NotFoundException
- conferralId
is not
foundNullArgumentException
- conferralId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.