org.osid.course.program

Interface EnrollmentQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

EnrollmentSearchSession

public interface EnrollmentQuerySession
extends OsidSession

This session provides methods for searching among Enrollment objects. The search query is constructed using the EnrollmentQuery.

This session defines views that offer differing behaviors for searching.

• federated course catalog view: searches include enrollments in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
• isolated course catalog view: searches are restricted to enrollments in this course catalog

enrollments may have a query record indicated by their respective recor types. The query record is accessed via the EnrollmentQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchEnrollments() 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.
EnrollmentQuery	getEnrollmentQuery() Gets an enrollment query.
EnrollmentList	getEnrollmentsByQuery(EnrollmentQuery enrollmentQuery) Gets a list of Enrollments matching the given enrollment query.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.

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.

canSearchEnrollments

boolean canSearchEnrollments()

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 search 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 enrollments in course catalog which are children of this course 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 lookups to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

getEnrollmentQuery

EnrollmentQuery getEnrollmentQuery()

Gets an enrollment query.

Returns:

the enrollment query

Compliance:

mandatory - This method must be implemented.

getEnrollmentsByQuery

EnrollmentList getEnrollmentsByQuery(EnrollmentQuery enrollmentQuery)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a list of Enrollments matching the given enrollment query.

Parameters:

enrollmentQuery - the enrollment query

Returns:

the returned EnrollmentList

Throws:

NullArgumentException - enrollmentQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - enrollmentQuery is not of this service

Compliance:

mandatory - This method must be implemented.