org.osid.course

Interface CourseOfferingSmartCourseCatalogSession

All Superinterfaces:

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

public interface CourseOfferingSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A CourseOfferingQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of CourseOfferings. The course offerings may be sequenced using the CourseOfferingSearchOrder from this session.

This CourseCatalog has a default query that matches any course offering and a default search order that specifies no sequencing. The queries may be examined using a CourseOfferingQueryInspector. The query may be modified by converting the inspector back to a CourseOfferingQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCourseOfferingQuery(CourseOfferingQuery courseOfferingQuery) Applies a course offering query to this course catalog.
void	applyCourseOfferingSequencing(CourseOfferingSearchOrder courseOfferingSearchOrder) Applies a course offering 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.
CourseOfferingQuery	getCourseOfferingQuery() Gets a course offering query.
CourseOfferingQuery	getCourseOfferingQueryFromInspector(CourseOfferingQueryInspector courseOfferingQueryInspector) Gets a course offering query from an inspector.
CourseOfferingSearchOrder	getCourseOfferingSearchOrder() Gets a course offering search order.
CourseOfferingQueryInspector	inspectCourseOfferingQuery() Gets a course offering 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.

getCourseOfferingQuery

CourseOfferingQuery getCourseOfferingQuery()

Gets a course offering query.

Returns:

the course offering query

Compliance:

mandatory - This method must be implemented.

getCourseOfferingSearchOrder

CourseOfferingSearchOrder getCourseOfferingSearchOrder()

Gets a course offering search order.

Returns:

the course offering search order

Compliance:

mandatory - This method must be implemented.

applyCourseOfferingQuery

void applyCourseOfferingQuery(CourseOfferingQuery courseOfferingQuery)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a course offering query to this course catalog.

Parameters:

courseOfferingQuery - the course offering query

Throws:

NullArgumentException - courseOfferingQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - courseOfferingQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCourseOfferingQuery

CourseOfferingQueryInspector inspectCourseOfferingQuery()
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets a course offering query inspector for this course catalog.

Returns:

the course offering query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCourseOfferingSequencing

void applyCourseOfferingSequencing(CourseOfferingSearchOrder courseOfferingSearchOrder)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies a course offering search order to this course catalog.

Parameters:

courseOfferingSearchOrder - the course offering search order

Throws:

NullArgumentException - courseOfferingSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - courseOfferingSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCourseOfferingQueryFromInspector

CourseOfferingQuery getCourseOfferingQueryFromInspector(CourseOfferingQueryInspector courseOfferingQueryInspector)

Gets a course offering query from an inspector.

Parameters:

courseOfferingQueryInspector - a query inspector

Returns:

the course offering query

Throws:

NullArgumentException - courseOfferingQueryInspector is null

UnsupportedException - courseOfferingQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.