public interface AssessmentEntryCourseCatalogSession extends OsidSession
This session provides methods to retrieve AssessmentEntry
to CourseCatalog
mappings. An
AssessmentEntry
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 assessment entry/course
catalog mappings.
|
AssessmentEntryList |
getAssessmentEntriesByCourseCatalog(Id courseCatalogId)
Gets the list of
AssessmentEntries associated with a
CourseCatalog. |
AssessmentEntryList |
getAssessmentEntriesByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
AssessmentEntries corresponding to a
list of CourseCatalog objects. |
IdList |
getAssessmentEntryIdsByCourseCatalog(Id courseCatalogId)
Gets the list of
AssessmentEntry Ids associated with a
CourseCatalog. |
IdList |
getAssessmentEntryIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
AssessmentEntry Ids corresponding to a
list of CourseCatalog objects. |
IdList |
getCourseCatalogIdsByAssessmentEntry(Id assessmentEntryId)
Gets the
CourseCatalog Ids mapped to an
AssessmentEntry. |
CourseCatalogList |
getCourseCatalogsByAssessmentEntry(Id assessmentEntryId)
Gets the
CourseCatalog objects mapped to an
AssessmentEntry. |
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
AssessmentEntry 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()
AssessmentEntry
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 getAssessmentEntryIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentEntry 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. AssessmentEntryList getAssessmentEntriesByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentEntries
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 getAssessmentEntryIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
AssessmentEntry 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. AssessmentEntryList getAssessmentEntriesByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
AssessmentEntries
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 getCourseCatalogIdsByAssessmentEntry(Id assessmentEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to an
AssessmentEntry.
assessmentEntryId
- Id
of a
pAssessmentEntry
Ids
NotFoundException
- assessmentEntryId
is
not foundNullArgumentException
- assessmentEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByAssessmentEntry(Id assessmentEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to an
AssessmentEntry.
assessmentEntryId
- Id
of an
AssessmentEntry
NotFoundException
- assessmentEntryId
is
not foundNullArgumentException
- assessmentEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.