org.osid.course.program

Interface EnrollmentLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface EnrollmentLookupSession
extends OsidSession

This session defines methods for retrieving enrollments. An Enrollment is a relationship between a student and an ProgramOffering.

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
• isolated course catalog view: All enrollment methods in this session operate, retrieve and pertain to enrollments defined explicitly in the current course catalog. Using an isolated view is useful for managing Enrollments with the EnrollmentAdminSession.
• federated course catalog view: All enrollment lookup methods in this session operate, retrieve and pertain to all enrollments defined in this course catalog and any other enrollments implicitly available in this course catalog through course catalog inheritence.
• effective vote view: All enrollment lookup methods return enrollments where the current date falls in between the effective dates inclusive.
• any effective vote view: enrollments of any effective date are returned from methods.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

Enrollments may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Enrollment.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupEnrollments() Tests if this user can perform Enrollment lookups.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
Enrollment	getEnrollment(Id enrollmentId) Gets the Enrollment specified by its Id.
EnrollmentList	getEnrollments() Gets all Enrollments.
EnrollmentList	getEnrollmentsByGenusType(Type enrollmentGenusType) Gets an EnrollmentList corresponding to the given enrollment genus Type which does not include enrollments of types derived from the specified Type.
EnrollmentList	getEnrollmentsByIds(IdList enrollmentIds) Gets an EnrollmentList corresponding to the given IdList.
EnrollmentList	getEnrollmentsByParentGenusType(Type enrollmentGenusType) Gets an EnrollmentList corresponding to the given course genus Type and include any additional enrollments with genus types derived from the specified Type.
EnrollmentList	getEnrollmentsByRecordType(Type enrollmentRecordType) Gets an EnrollmentList containing the given enrollment record Type.
EnrollmentList	getEnrollmentsForProgram(Id programId) Gets all Enrollments related to a program.
EnrollmentList	getEnrollmentsForProgramAndStudent(Id programId, Id resourceId) Gets all Enrollments for a given program and student.
EnrollmentList	getEnrollmentsForProgramAndStudentOnDate(Id programId, Id resourceId, DateTime from, DateTime to) Gets all Enrollments for a program and student effective during the entire given date range inclusive but not confined to the date range.
EnrollmentList	getEnrollmentsForProgramOffering(Id programOfferingId) Gets all Enrollments associated with a given ProgramOffering.
EnrollmentList	getEnrollmentsForProgramOfferingAndStudent(Id programOfferingId, Id resourceId) Gets all Enrollments for a given program offering and student.
EnrollmentList	getEnrollmentsForProgramOfferingAndStudentOnDate(Id programOfferingId, Id resourceId, DateTime from, DateTime to) Gets all Enrollments for a program offering and student effective during the entire given date range inclusive but not confined to the date range.
EnrollmentList	getEnrollmentsForProgramOfferingOnDate(Id programOfferingId, DateTime from, DateTime to) Gets all Enrollments effective during the entire given date range inclusive but not confined to the date range.
EnrollmentList	getEnrollmentsForProgramOnDate(Id programId, DateTime from, DateTime to) Gets all Enrollments for a program effective during the entire given date range inclusive but not confined to the date range.
EnrollmentList	getEnrollmentsForStudent(Id resourceId) Gets all Enrollments for a given student.
EnrollmentList	getEnrollmentsForStudentOnDate(Id resourceId, DateTime from, DateTime to) Gets all Enrollments for a student during the entire given date range inclusive but not confined to the date range.
EnrollmentList	getEnrollmentsOnDate(DateTime from, DateTime to) Gets all Enrollments effective during the entire given date range inclusive but not confined to the date range.
void	useAnyEffectiveEnrollmentView() All enrollments of any effective dates are returned by methods in this session.
void	useComparativeEnrollmentView() 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	useEffectiveEnrollmentView() Only enrollments whose effective dates are current are returned by methods in this session.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.
void	usePlenaryEnrollmentView() A complete view of the Enrollment returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canLookupEnrollments

boolean canLookupEnrollments()

Tests if this user can perform Enrollment 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.

useComparativeEnrollmentView

void useComparativeEnrollmentView()

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.

usePlenaryEnrollmentView

void usePlenaryEnrollmentView()

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

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

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

useEffectiveEnrollmentView

void useEffectiveEnrollmentView()

Only enrollments whose effective dates are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveEnrollmentView

void useAnyEffectiveEnrollmentView()

All enrollments of any effective dates are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getEnrollment

Enrollment getEnrollment(Id enrollmentId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the Enrollment specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Enrollment may have a different Id than requested, such as the case where a duplicate Id was assigned to a Enrollment and retained for compatibility. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

enrollmentId - the Id of the Enrollment to retrieve

Returns:

the returned Enrollment

Throws:

NotFoundException - no Enrollment found with the given Id

NullArgumentException - enrollmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsByIds

EnrollmentList getEnrollmentsByIds(IdList enrollmentIds)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets an EnrollmentList corresponding to the given IdList. In plenary mode, the returned list contains all of the enrollments specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Enrollments may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

enrollmentIds - the list of Ids to retrieve

Returns:

the returned Enrollment list

Throws:

NotFoundException - an Id was not found

NullArgumentException - enrollmentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsByGenusType

EnrollmentList getEnrollmentsByGenusType(Type enrollmentGenusType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets an EnrollmentList corresponding to the given enrollment genus Type which does not include enrollments of types derived from the specified Type. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

enrollmentGenusType - an enrollment genus type

Returns:

the returned Enrollment list

Throws:

NullArgumentException - enrollmentGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsByParentGenusType

EnrollmentList getEnrollmentsByParentGenusType(Type enrollmentGenusType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets an EnrollmentList corresponding to the given course genus Type and include any additional enrollments with genus types derived from the specified Type. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

enrollmentGenusType - an enrollment genus type

Returns:

the returned Enrollment list

Throws:

NullArgumentException - enrollmentGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsByRecordType

EnrollmentList getEnrollmentsByRecordType(Type enrollmentRecordType)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets an EnrollmentList containing the given enrollment record Type. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

enrollmentRecordType - an enrollment record type

Returns:

the returned Enrollment list

Throws:

NullArgumentException - enrollmentRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsOnDate

EnrollmentList getEnrollmentsOnDate(DateTime from,
                                  DateTime to)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets all Enrollments effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

from - start of date range

to - end of date range

Returns:

a list of Enrollments

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForProgramOffering

EnrollmentList getEnrollmentsForProgramOffering(Id programOfferingId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets all Enrollments associated with a given ProgramOffering. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

programOfferingId - a program offering Id

Returns:

a list of Enrollments

Throws:

NullArgumentException - programOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForProgramOfferingOnDate

EnrollmentList getEnrollmentsForProgramOfferingOnDate(Id programOfferingId,
                                                    DateTime from,
                                                    DateTime to)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets all Enrollments effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

programOfferingId - a program offering Id

from - start of date range

to - end of date range

Returns:

a list of Enrollments

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - programOfferingId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForStudent

EnrollmentList getEnrollmentsForStudent(Id resourceId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets all Enrollments for a given student. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

resourceId - a resource Id

Returns:

a list of Enrollments

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForStudentOnDate

EnrollmentList getEnrollmentsForStudentOnDate(Id resourceId,
                                            DateTime from,
                                            DateTime to)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets all Enrollments for a student during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

resourceId - a resource Id

from - start of date range

to - end of date range

Returns:

a list of Enrollments

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForProgramOfferingAndStudent

EnrollmentList getEnrollmentsForProgramOfferingAndStudent(Id programOfferingId,
                                                        Id resourceId)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets all Enrollments for a given program offering and student. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

programOfferingId - a program offering Id

resourceId - a resource Id

Returns:

a list of Enrollments

Throws:

NullArgumentException - programOfferingId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForProgramOfferingAndStudentOnDate

EnrollmentList getEnrollmentsForProgramOfferingAndStudentOnDate(Id programOfferingId,
                                                              Id resourceId,
                                                              DateTime from,
                                                              DateTime to)
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

Gets all Enrollments for a program offering and student effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

programOfferingId - a program offering Id

resourceId - a resource Id

from - start of date range

to - end of date range

Returns:

a list of Enrollments

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - programOfferingId, resourceId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForProgram

EnrollmentList getEnrollmentsForProgram(Id programId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets all Enrollments related to a program. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

programId - a program Id

Returns:

a list of Enrollments

Throws:

NullArgumentException - programId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForProgramOnDate

EnrollmentList getEnrollmentsForProgramOnDate(Id programId,
                                            DateTime from,
                                            DateTime to)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets all Enrollments for a program effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

programId - a program Id

from - start of date range

to - end of date range

Returns:

a list of Enrollments

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - programId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForProgramAndStudent

EnrollmentList getEnrollmentsForProgramAndStudent(Id programId,
                                                Id resourceId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets all Enrollments for a given program and student. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

programId - a program Id

resourceId - a resource Id

Returns:

a list of Enrollments

Throws:

NullArgumentException - programId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollmentsForProgramAndStudentOnDate

EnrollmentList getEnrollmentsForProgramAndStudentOnDate(Id programId,
                                                      Id resourceId,
                                                      DateTime from,
                                                      DateTime to)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets all Enrollments for a program and student effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Parameters:

programId - a program Id

resourceId - a resource Id

from - start of date range

to - end of date range

Returns:

a list of Enrollments

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - programId, resourceId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnrollments

EnrollmentList getEnrollments()
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets all Enrollments. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.

Returns:

a list of Enrollments

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.