public interface AwardAcademySession extends OsidSession
This session provides methods to retrieve Award
to
Academy
mappings. An Award
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 |
canLookupAwardAcademyMappings()
Tests if this user can perform lookups of award/academy mappings.
|
AcademyList |
getAcademiesByAward(Id awardId)
Gets the list of
Academy objects mapped to an
Award. |
IdList |
getAcademyIdsByAward(Id awardId)
Gets the list of
Academy Ids mapped to
an Award. |
IdList |
getAwardIdsByAcademies(IdList academyIds)
Gets the list of
Award Ids corresponding to a list of
Academy objects. |
IdList |
getAwardIdsByAcademy(Id academyId)
Gets the list of Award Ids associated with an
Academy. |
AwardList |
getAwardsByAcademies(IdList academyIds)
Gets the list of
Awards corresponding to a list of
Academies. |
AwardList |
getAwardsByAcademy(Id academyId)
Gets the list of
Awards 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
Award and Academy
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAwardAcademyMappings()
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()
Award
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 getAwardIdsByAcademy(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. AwardList getAwardsByAcademy(Id academyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Awards
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 getAwardIdsByAcademies(IdList academyIds) throws OperationFailedException, PermissionDeniedException
Award 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. AwardList getAwardsByAcademies(IdList academyIds) throws OperationFailedException, PermissionDeniedException
Awards
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 getAcademyIdsByAward(Id awardId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Academy
Ids
mapped to
an Award.
awardId
- Id
of an Award
Ids
NotFoundException
- awardId
is not foundNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AcademyList getAcademiesByAward(Id awardId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Academy
objects mapped to an
Award.
awardId
- Id
of an Award
NotFoundException
- awardId
is not foundNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.