Interface AcademicRecordSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AcademicRecordSession
extends OsidSession

This session defines methods for retrieving an acedmic record for a student. Lookup methods assume 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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                        throws OperationFailedException,
PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupAcademicRecord

boolean canLookupAcademicRecord()

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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

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.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

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.

getCompletedProgramEntriesForStudent

ProgramEntryList getCompletedProgramEntriesForStudent(Id resourceId)
                                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets completed program entries for a student with summary results.

Parameters:

resourceId - the Id of a Resource

Returns:

the returned ProgramEntryList

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrolledProgramEntriesForStudent

ProgramEntryList getEnrolledProgramEntriesForStudent(Id resourceId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

resourceId - the Id of a Resource

Returns:

the returned ProgramEntryList

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesByTermForStudent

ProgramEntryList getProgramEntriesByTermForStudent(Id resourceId,
 Id termId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

resourceId - the Id of a Resource

termId - the Id of a Term

Returns:

the returned ProgramEntryList

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId or termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseEntriesByTermForStudent

CourseEntryList getCourseEntriesByTermForStudent(Id resourceId,
 Id termId)
                                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

resourceId - the Id of a Resource

termId - the Id of a Term

Returns:

the returned CourseEntryList

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId or termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCompletedCourseEntriesForStudent

CourseEntryList getCompletedCourseEntriesForStudent(Id resourceId)
                                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all completed course entries for a student.

Parameters:

resourceId - the Id of a Resource

Returns:

the returned CourseEntryList

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesForStudent

CredentialEntryList getCredentialEntriesForStudent(Id resourceId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all effective credential entries for a student.

Parameters:

resourceId - the Id of a Resource

Returns:

the returned CredentialEntryList

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesByDateForStudent

CredentialEntryList getCredentialEntriesByDateForStudent(Id resourceId,
 DateTime from,
 DateTime to)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

resourceId - the Id of a Resource

from - starting date

to - ending date

Returns:

the returned CredentialEntryList

Throws:

InvalidArgumentException - from is greater than to

NotFoundException - resourceId is not found

NullArgumentException - resourceId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesForStudent

AssessmentEntryList getAssessmentEntriesForStudent(Id resourceId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all effective assessment entries for a student.

Parameters:

resourceId - the Id of a Resource

Returns:

the returned AssessmentEntryList

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesByDateForStudent

AssessmentEntryList getAssessmentEntriesByDateForStudent(Id resourceId,
 DateTime from,
 DateTime to)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

resourceId - the Id of a Resource

from - starting date

to - ending date

Returns:

the returned AssessmentEntryList

Throws:

InvalidArgumentException - from is greater than to

NotFoundException - resourceId is not found

NullArgumentException - resourceId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesForStudent

AwardEntryList getAwardEntriesForStudent(Id resourceId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all effective award entries for a student.

Parameters:

resourceId - the Id of a Resource

Returns:

the returned AwardEntryList

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesByDateForStudent

AwardEntryList getAwardEntriesByDateForStudent(Id resourceId,
 DateTime from,
 DateTime to)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

resourceId - the Id of a Resource

from - starting date

to - ending date

Returns:

the returned AwardEntryList

Throws:

InvalidArgumentException - from is greater than to

NotFoundException - resourceId is not found

NullArgumentException - resourceId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.