public interface AcademicRecordSession extends OsidSession
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:
ProgramEntries
with the
ProgramEntry AdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAcademicRecord()
Tests if this user can perform academic record lookups.
|
AssessmentEntryList |
getAssessmentEntriesByDateForStudent(Id resourceId,
DateTime from,
DateTime to)
Gets all effective assessment entries for a student completed within
the given date range inclusive.
|
AssessmentEntryList |
getAssessmentEntriesForStudent(Id resourceId)
Gets all effective assessment entries for a student.
|
AwardEntryList |
getAwardEntriesByDateForStudent(Id resourceId,
DateTime from,
DateTime to)
Gets all effective award entries for a student completed within the
given date range inclusive.
|
AwardEntryList |
getAwardEntriesForStudent(Id resourceId)
Gets all effective award entries for a student.
|
CourseEntryList |
getCompletedCourseEntriesForStudent(Id resourceId)
Gets all completed course entries for a student.
|
ProgramEntryList |
getCompletedProgramEntriesForStudent(Id resourceId)
Gets completed program entries for a student with summary results.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
CourseEntryList |
getCourseEntriesByTermForStudent(Id resourceId,
Id termId)
Gets all effective course entries for a student in the given term.
|
CredentialEntryList |
getCredentialEntriesByDateForStudent(Id resourceId,
DateTime from,
DateTime to)
Gets all effective credential entries for a student awarded within the
given date range inclusive.
|
CredentialEntryList |
getCredentialEntriesForStudent(Id resourceId)
Gets all effective credential entries for a student.
|
ProgramEntryList |
getEnrolledProgramEntriesForStudent(Id resourceId)
Gets program entries for a student in which the student is currently
enrolled.
|
ProgramEntryList |
getProgramEntriesByTermForStudent(Id resourceId,
Id termId)
Gets all effective program entries for a student in the given term.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupAcademicRecord()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. ProgramEntryList getCompletedProgramEntriesForStudent(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
ProgramEntryList
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getEnrolledProgramEntriesForStudent(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
ProgramEntryList
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesByTermForStudent(Id resourceId, Id termId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
termId
- the Id
of a Term
ProgramEntryList
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
or
termId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseEntryList getCourseEntriesByTermForStudent(Id resourceId, Id termId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
termId
- the Id
of a Term
CourseEntryList
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
or
termId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseEntryList getCompletedCourseEntriesForStudent(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
CourseEntryList
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesForStudent(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
CredentialEntryList
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesByDateForStudent(Id resourceId, DateTime from, DateTime to) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
from
- starting dateto
- ending date CredentialEntryList
InvalidArgumentException
- from
is
greater than to
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId, from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesForStudent(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
AssessmentEntryList
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesByDateForStudent(Id resourceId, DateTime from, DateTime to) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
from
- starting dateto
- ending date AssessmentEntryList
InvalidArgumentException
- from
is
greater than to
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId, from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesForStudent(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
AwardEntryList
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesByDateForStudent(Id resourceId, DateTime from, DateTime to) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a Resource
from
- starting dateto
- ending date AwardEntryList
InvalidArgumentException
- from
is
greater than to
NotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId, from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.