Interface | osid.course.chronicle.AcademicRecordSession | ||
---|---|---|---|
Implements | osid.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:
| ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupAcademicRecord | ||
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 | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedCourseCatalogView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCourseCatalogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCompletedProgramEntriesForStudent | ||
Description |
Gets completed program entries for a student with summary results. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
Return | osid.course.chronicle.ProgramEntryList | the returned ProgramEntryList | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEnrolledProgramEntriesForStudent | ||
Description |
Gets program entries for a student in which the student is currently enrolled. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
Return | osid.course.chronicle.ProgramEntryList | the returned ProgramEntryList | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntriesByTermForStudent | ||
Description |
Gets all effective program entries for a student in the given term. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
osid.id.Id | termId | the Id of a Term | |
Return | osid.course.chronicle.ProgramEntryList | the returned ProgramEntryList | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId or termId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseEntriesByTermForStudent | ||
Description |
Gets all effective course entries for a student in the given term. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
osid.id.Id | termId | the Id of a Term | |
Return | osid.course.chronicle.CourseEntryList | the returned CourseEntryList | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId or termId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCompletedCourseEntriesForStudent | ||
Description |
Gets all completed course entries for a student. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
Return | osid.course.chronicle.CourseEntryList | the returned CourseEntryList | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialEntriesForStudent | ||
Description |
Gets all effective credential entries for a student. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
Return | osid.course.chronicle.CredentialEntryList | the returned CredentialEntryList | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialEntriesByDateForStudent | ||
Description |
Gets all effective credential entries for a student awarded within the given date range inclusive. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.CredentialEntryList | the returned CredentialEntryList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NOT_FOUND | resourceId is not found | ||
NULL_ARGUMENT | resourceId, from , or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesForStudent | ||
Description |
Gets all effective assessment entries for a student. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesByDateForStudent | ||
Description |
Gets all effective assessment entries for a student completed within the given date range inclusive. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NOT_FOUND | resourceId is not found | ||
NULL_ARGUMENT | resourceId, from , or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesForStudent | ||
Description |
Gets all effective award entries for a student. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesByDateForStudent | ||
Description |
Gets all effective award entries for a student completed within the given date range inclusive. | ||
Parameters | osid.id.Id | resourceId | the Id of a Resource |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NOT_FOUND | resourceId is not found | ||
NULL_ARGUMENT | resourceId, from , or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |