Interface EnrollmentCourseCatalogSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EnrollmentCourseCatalogSession
extends OsidSession

This session provides methods to retrieve Enrollment to CourseCatalog mappings. An Enrollment may appear in multiple CourseCatalogs. Each catalog may have its own authorizations governing who is allowed to look at it.

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupEnrollmentCatalogMappings()	Tests if this user can perform lookups of enrollment/course catalog mappings.
IdList	getCatalogIdsByEnrollment(Id enrollmentId)	Gets the CourseCatalog Ids mapped to an Enrollment.
CourseCatalogList	getCatalogsByEnrollment(Id enrollmentId)	Gets the CourseCatalog objects mapped to an Enrollment .
IdList	getEnrollmentIdsByCatalog(Id courseCatalogId)	Gets the list of Enrollment Ids associated with a CourseCatalog.
IdList	getEnrollmentIdsByCatalogs(IdList courseCatalogIdList)	Gets the list of Enrollment Ids corresponding to a list of CourseCatalog objects.
EnrollmentList	getEnrollmentsByCatalog(Id courseCatalogId)	Gets the list of Enrollments associated with a CourseCatalog.
EnrollmentList	getEnrollmentsByCatalogs(IdList courseCatalogIdList)	Gets the list of Enrollments corresponding to a list of CourseCatalog objects.
void	useComparativeEnrollmentCatalogView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryEnrollmentCatalogView()	A complete view of the Enrollment and CourseCatalog returns is desired.

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

canLookupEnrollmentCatalogMappings

boolean canLookupEnrollmentCatalogMappings()

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

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeEnrollmentCatalogView

void useComparativeEnrollmentCatalogView()

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.

Compliance:

mandatory - This method is must be implemented.

usePlenaryEnrollmentCatalogView

void usePlenaryEnrollmentCatalogView()

A complete view of the Enrollment and CourseCatalog 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.

Compliance:

mandatory - This method is must be implemented.

getEnrollmentIdsByCatalog

IdList getEnrollmentIdsByCatalog(Id courseCatalogId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Enrollment Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related enrollment Ids

Throws:

NotFoundException - courseCatalogId is not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsByCatalog

EnrollmentList getEnrollmentsByCatalog(Id courseCatalogId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Enrollments associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related enrollments

Throws:

NotFoundException - courseCatalogId is not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentIdsByCatalogs

IdList getEnrollmentIdsByCatalogs(IdList courseCatalogIdList)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of Enrollment Ids corresponding to a list of CourseCatalog objects.

Parameters:

courseCatalogIdList - list of course catalog Ids

Returns:

list of enrollment Ids

Throws:

NullArgumentException - courseCatalogIdList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsByCatalogs

EnrollmentList getEnrollmentsByCatalogs(IdList courseCatalogIdList)
                                 throws OperationFailedException,
PermissionDeniedException

Gets the list of Enrollments corresponding to a list of CourseCatalog objects.

Parameters:

courseCatalogIdList - list of course catalog Ids

Returns:

list of enrollments

Throws:

NullArgumentException - courseCatalogIdList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogIdsByEnrollment

IdList getCatalogIdsByEnrollment(Id enrollmentId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the CourseCatalog Ids mapped to an Enrollment.

Parameters:

enrollmentId - Id of an Enrollment

Returns:

list of course catalogs

Throws:

NotFoundException - enrollmentId is not found

NullArgumentException - enrollmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogsByEnrollment

CourseCatalogList getCatalogsByEnrollment(Id enrollmentId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the CourseCatalog objects mapped to an Enrollment .

Parameters:

enrollmentId - Id of an Enrollment

Returns:

list of course catalogs

Throws:

NotFoundException - enrollmentId is not found

NullArgumentException - enrollmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.