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

This session defines methods for retrieving an acedmic record for a student. Lookup methods assume a only effective entries are returned.

This lookup session defines several views:

  • isolated course catalog view: All program entry methods in this session operate, retrieve and pertain to program entries defined explicitly in the current course catalog. Using an isolated view is useful for managing ProgramEntries with the ProgramEntry AdminSession.
  • federated course catalog view: All program entry lookup methods in this session operate, retrieve and pertain to all program entries defined in this course catalog and any other program entries implicitly available in this course catalog through course catalog inheritence.
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.
MethodcanLookupAcademicRecord
Description

Tests if this user can perform academic record 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.
MethoduseFederatedCourseCatalogView
Description

Federates the view for methods in this session. A federated view will include entries 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.
MethodgetCompletedProgramEntriesForStudent
Description

Gets completed program entries for a student with summary results.

Parametersosid.id.IdresourceIdthe Id of a Resource
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEnrolledProgramEntriesForStudent
Description

Gets program entries for a student in which the student is currently enrolled.

Parametersosid.id.IdresourceIdthe Id of a Resource
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesByTermForStudent
Description

Gets all effective program entries for a student in the given term.

Parametersosid.id.IdresourceIdthe Id of a Resource
osid.id.IdtermIdthe Id of a Term
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId or termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntriesByTermForStudent
Description

Gets all effective course entries for a student in the given term.

Parametersosid.id.IdresourceIdthe Id of a Resource
osid.id.IdtermIdthe Id of a Term
Returnosid.course.chronicle.CourseEntryListthe returned CourseEntryList
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId or termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompletedCourseEntriesForStudent
Description

Gets all completed course entries for a student.

Parametersosid.id.IdresourceIdthe Id of a Resource
Returnosid.course.chronicle.CourseEntryListthe returned CourseEntryList
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialEntriesForStudent
Description

Gets all effective credential entries for a student.

Parametersosid.id.IdresourceIdthe Id of a Resource
Returnosid.course.chronicle.CredentialEntryListthe returned CredentialEntryList
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialEntriesByDateForStudent
Description

Gets all effective credential entries for a student awarded within the given date range inclusive.

Parametersosid.id.IdresourceIdthe Id of a Resource
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.CredentialEntryListthe returned CredentialEntryList
ErrorsINVALID_ARGUMENT from is greater than to
NOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId, from , or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesForStudent
Description

Gets all effective assessment entries for a student.

Parametersosid.id.IdresourceIdthe Id of a Resource
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesByDateForStudent
Description

Gets all effective assessment entries for a student completed within the given date range inclusive.

Parametersosid.id.IdresourceIdthe Id of a Resource
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.AssessmentEntryListthe returned AssessmentEntryList
ErrorsINVALID_ARGUMENT from is greater than to
NOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId, from , or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesForStudent
Description

Gets all effective award entries for a student.

Parametersosid.id.IdresourceIdthe Id of a Resource
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesByDateForStudent
Description

Gets all effective award entries for a student completed within the given date range inclusive.

Parametersosid.id.IdresourceIdthe Id of a Resource
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList
ErrorsINVALID_ARGUMENT from is greater than to
NOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId, from , or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.