OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AssessmentEntryCourseCatalogSession
Implementsosid.OsidSession
Description

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:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupCourseCatalogMappings
Description

Tests if this user can perform lookups of assessment entry/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCourseCatalogView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCourseCatalogView
Description

A complete view of the 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.

CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentEntryIdsByCourseCatalog
Description

Gets the list of AssessmentEntry Ids associated with a CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of the CourseCatalog
Returnosid.id.IdListlist of related assessment entry Ids
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesByCourseCatalog
Description

Gets the list of AssessmentEntries associated with a CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of the CourseCatalog
Returnosid.course.chronicle.AssessmentEntryListlist of related assessment entries
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntryIdsByCourseCatalogs
Description

Gets the list of AssessmentEntry Ids corresponding to a list of CourseCatalog objects.

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.id.IdListlist of assessment entry Ids
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesByCourseCatalogs
Description

Gets the list of AssessmentEntries corresponding to a list of CourseCatalog objects.

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.course.chronicle.AssessmentEntryListlist of assessmente ntries
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdsByAssessmentEntry
Description

Gets the CourseCatalog Ids mapped to an AssessmentEntry.

Parametersosid.id.IdassessmentEntryId Id of a pAssessmentEntry
Returnosid.id.IdListlist of course catalog Ids
ErrorsNOT_FOUND assessmentEntryId is not found
NULL_ARGUMENT assessmentEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByAssessmentEntry
Description

Gets the CourseCatalog objects mapped to an AssessmentEntry.

Parametersosid.id.IdassessmentEntryId Id of an AssessmentEntry
Returnosid.course.CourseCatalogListlist of course catalogs
ErrorsNOT_FOUND assessmentEntryId is not found
NULL_ARGUMENT assessmentEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.