public interface ConvocationAcademySession extends OsidSession
This session provides methods to retrieve Convocation
to
Academy
mappings. A Convocation
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 |
canLookupConvocationAcademyMappings()
Tests if this user can perform lookups of convocation/academy
mappings.
|
AcademyList |
getAcademiesByConvocation(Id convocationId)
Gets the list of
Academy objects mapped to a
Convocation. |
IdList |
getAcademyIdsByConvocation(Id convocationId)
Gets the list of
Academy Ids mapped to a
Convocation. |
IdList |
getConvocationIdsByAcademies(IdList academyIds)
Gets the list of
Convocation Ids corresponding to a
list of Academy objects. |
IdList |
getConvocationIdsByAcademy(Id academyId)
Gets the list of Convocation Ids associated with an
Academy. |
ConvocationList |
getConvocationsByAcademies(IdList academyIds)
Gets the list of
Convocations corresponding to a list
of Academies. |
ConvocationList |
getConvocationsByAcademy(Id academyId)
Gets the list of
Convocations 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
Convocation and Academy
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupConvocationAcademyMappings()
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()
Convocation
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 getConvocationIdsByAcademy(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. ConvocationList getConvocationsByAcademy(Id academyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Convocations
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 getConvocationIdsByAcademies(IdList academyIds) throws OperationFailedException, PermissionDeniedException
Convocation 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. ConvocationList getConvocationsByAcademies(IdList academyIds) throws OperationFailedException, PermissionDeniedException
Convocations
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 getAcademyIdsByConvocation(Id convocationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Academy
Ids
mapped to a
Convocation.
convocationId
- Id
of a Convocation
Ids
NotFoundException
- convocationId
is not
foundNullArgumentException
- convocationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AcademyList getAcademiesByConvocation(Id convocationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Academy
objects mapped to a
Convocation.
convocationId
- Id
of a Convocation
NotFoundException
- convocationId
is not
foundNullArgumentException
- convocationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.