org.osid.course.program

Interface EnrollmentSmartCourseCatalogSession

All Superinterfaces:

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

public interface EnrollmentSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An EnrollmentQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Enrollments. The enrollments may be sequenced using the EnrollmentSearchOrder from this session.

This CourseCatalog has a default query that matches any enrollment and a default search order that specifies no sequencing. The queries may be examined using an EnrollmentQueryInspector. The query may be modified by converting the inspector back to an EnrollmentQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyEnrollmentQuery(EnrollmentQuery enrollmentQuery) Applies an enrollment query to this course catalog.
void	applyEnrollmentSequencing(EnrollmentSearchOrder enrollmentSearchOrder) Applies an enrollment search order to this course catalog.
boolean	canManageSmartCourseCatalogs() Tests if this user can manage smart course catalogs.
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.
EnrollmentQuery	getEnrollmentQueryFromInspector(EnrollmentQueryInspector enrollmentQueryInspector) Gets an enrollment query from an inspector.
EnrollmentSearchOrder	getEnrollmentSearchOrder() Gets an enrollment search order.
EnrollmentQueryInspector	inspectEnrollmentQuery() Gets an enrollment query inspector for this course catalog.

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.

canManageSmartCourseCatalogs

boolean canManageSmartCourseCatalogs()

Tests if this user can manage smart course catalogs. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart course catalog management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getEnrollmentQuery

EnrollmentQuery getEnrollmentQuery()

Gets an enrollment query.

Returns:

the enrollment query

Compliance:

mandatory - This method must be implemented.

getEnrollmentSearchOrder

EnrollmentSearchOrder getEnrollmentSearchOrder()

Gets an enrollment search order.

Returns:

the enrollment search order

Compliance:

mandatory - This method must be implemented.

applyEnrollmentQuery

void applyEnrollmentQuery(EnrollmentQuery enrollmentQuery)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies an enrollment query to this course catalog.

Parameters:

enrollmentQuery - the enrollment query

Throws:

NullArgumentException - enrollmentQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - enrollmentQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectEnrollmentQuery

EnrollmentQueryInspector inspectEnrollmentQuery()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets an enrollment query inspector for this course catalog.

Returns:

the enrollment query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyEnrollmentSequencing

void applyEnrollmentSequencing(EnrollmentSearchOrder enrollmentSearchOrder)
                               throws OperationFailedException,
                                      PermissionDeniedException

Applies an enrollment search order to this course catalog.

Parameters:

enrollmentSearchOrder - the enrollment search order

Throws:

NullArgumentException - enrollmentSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - enrollmentSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getEnrollmentQueryFromInspector

EnrollmentQuery getEnrollmentQueryFromInspector(EnrollmentQueryInspector enrollmentQueryInspector)

Gets an enrollment query from an inspector.

Parameters:

enrollmentQueryInspector - a query inspector

Returns:

the enrollment query

Throws:

NullArgumentException - enrollmentQueryInspector is null

UnsupportedException - enrollmentQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.