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

This session defines methods for retrieving entriesand entry components.

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
  • isolated course catalog view: All assessment entry methods in this session operate, retrieve and pertain to assessments defined explicitly in the current course catalog. Using an isolated view is useful for managing AssessmentEntries with the AssessmentEntry AdminSession.
  • federated course catalog view: All assessment entry lookup methods in this session operate, retrieve and pertain to all assessments defined in this course catalog and any other assessments implicitly available in this course catalog through course catalog inheritence.
  • effective assessment entry view: All assessment entry lookup methods return assessment entry where the current date falls in between the effective dates inclusive.
  • any assessment entry view: Assessment entries of any effective date are returned from methods.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

AssessmentEntries may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the AssessmentEntry.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupAssessmentEntries
Description

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

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAssessmentEntryView
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.
MethodusePlenaryAssessmentEntryView
Description

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

Federates the view for methods in this session. A federated view will include assessments in catalogs which are children of this catalog in the course catalog hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveAssessmentEntryView
Description

Only assessment entries whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveAssessmentEntryView
Description

All assessment entries of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentEntry
Description

Gets the AssessmentEntry specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AssessmentEntry may have a different Id than requested, such as the case where a duplicate Id was assigned to an AssessmentEntry and retained for compatibility.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.id.IdassessmentEntryIdthe Id of the AssessmentEntry to retrieve
Returnosid.course.chronicle.AssessmentEntrythe returned chronicle
ErrorsNOT_FOUNDno AssessmentEntry found with the given Id
NULL_ARGUMENT assessmentEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesByIds
Description

Gets an AssessmentEntryList corresponding to the given IdList.

In plenary mode, the returned list contains all of the assessments specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AssessmentEntries may be omitted from the list and may present the elements in any order including returning a unique set.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.id.IdListassessmentEntryIdthe list of Ids to retrieve
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT assessmentEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesByGenusType
Description

Gets an AssessmentEntryList corresponding to the given assessment entry genus Type which does not include assessments of types derived from the specified Type.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.type.TypeassessmentEntryGenusTypean assessment entry genus type
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList
ErrorsNULL_ARGUMENT assessmentEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesByParentGenusType
Description

Gets an AssessmentEntryList corresponding to the given assessment entry genus Type and include any additional assessments with genus types derived from the specified Type.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.type.TypeassessmentEntryGenusTypean assessment entry genus type
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList
ErrorsNULL_ARGUMENT assessmentEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesByRecordType
Description

Gets an AssessmentEntryList containing the given assessment entry record Type.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.type.TypeassessmentEntryRecordTypean assessment entry record type
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList list
ErrorsNULL_ARGUMENT assessmentEntryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesOnDate
Description

Gets an AssessmentEntryList effectiveduring the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesForStudent
Description

Gets an AssessmentEntryList for the given student .

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesForStudentOnDate
Description

Gets an AssessmentEntryList for the given student effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from , or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesForAssessment
Description

Gets an AssessmentEntryList for the given assessment.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.id.IdassessmentIdan assessment Id
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList list
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesForAssessmentOnDate
Description

Gets an AssessmentEntryList for the given assessment effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.id.IdassessmentIdan assessment Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT assessmentId, from , or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesForStudentAndAssessment
Description

Gets an AssessmentEntryList for the given student and assessment .

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdassessmentIdan assessment Id
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList list
ErrorsNULL_ARGUMENT resourceId or assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesForStudentAndAssessmentOnDate
Description

Gets an AssessmentEntryList for the given student and assessment effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdassessmentIdan assessment Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, assessmentId, from , or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntries
Description

Gets all AssessmentEntries.

In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Returnosid.course.chronicle.AssessmentEntryLista list of AssessmentEntries
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.