public interface AwardEntryCourseCatalogSession extends OsidSession
This session provides methods to retrieve AwardEntry
to
CourseCatalog
mappings. An AwardEntry
may
appear in multiple CourseCatalog
objects. Each catalog 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 |
canLookupCourseCatalogMappings()
Tests if this user can perform lookups of award entry/course catalog
mappings.
|
AwardEntryList |
getAwardEntriesByCourseCatalog(Id courseCatalogId)
Gets the list of
AwardEntries associated with a
CourseCatalog. |
AwardEntryList |
getAwardEntriesByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
AwardEntries corresponding to a list
of CourseCatalog objects. |
IdList |
getAwardEntryIdsByCourseCatalog(Id courseCatalogId)
Gets the list of
AwardEntry Ids associated with a
CourseCatalog. |
IdList |
getAwardEntryIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
AwardEntry Ids corresponding to a list
of CourseCatalog objects. |
IdList |
getCourseCatalogIdsByAwardEntry(Id awardEntryId)
Gets the
CourseCatalog Ids mapped to an
AwardEntry. |
CourseCatalogList |
getCourseCatalogsByAwardEntry(Id awardEntryId)
Gets the
CourseCatalog objects mapped to an
AwardEntry. |
void |
useComparativeCourseCatalogView()
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 |
usePlenaryCourseCatalogView()
A complete view of the
AwardEntry and
CourseCatalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCourseCatalogMappings()
PERMISSION_DENIED.
This is intended as 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 useComparativeCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryCourseCatalogView()
AwardEntry
and
CourseCatalog
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 getAwardEntryIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AwardEntry Ids
associated with a
CourseCatalog.
courseCatalogId
- Id
of the CourseCatalog
Ids
NotFoundException
- courseCatalogId
is
not foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AwardEntries
associated with a
CourseCatalog.
courseCatalogId
- Id
of the CourseCatalog
NotFoundException
- courseCatalogId
is
not foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAwardEntryIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
AwardEntry Ids
corresponding to a list
of CourseCatalog
objects.courseCatalogIds
- list of course catalog Ids
Ids
NullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
AwardEntries
corresponding to a list
of CourseCatalog
objects.courseCatalogIds
- list of course catalog Ids
NullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCourseCatalogIdsByAwardEntry(Id awardEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to an
AwardEntry.
awardEntryId
- Id
of a pAwardEntry
Ids
NotFoundException
- awardEntryId
is not
foundNullArgumentException
- awardEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByAwardEntry(Id awardEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to an
AwardEntry.
awardEntryId
- Id
of an AwardEntry
NotFoundException
- awardEntryId
is not
foundNullArgumentException
- awardEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.