org.osid.course

Interface CourseSmartCourseCatalogSession

All Superinterfaces:

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

public interface CourseSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A CourseQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Courses. The courses may be sequenced using the CourseSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCourseQuery(CourseQuery courseQuery) Applies a course query to this course catalog.
void	applyCourseSequencing(CourseSearchOrder courseSearchOrder) Applies a course 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.
CourseQuery	getCourseQuery() Gets a course query.
CourseQuery	getCourseQueryFromInspector(CourseQueryInspector courseQueryInspector) Gets a course query from an inspector.
CourseSearchOrder	getCourseSearchOrder() Gets a course search order.
CourseQueryInspector	inspectCourseQuery() Gets a course 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.

getCourseQuery

CourseQuery getCourseQuery()

Gets a course query.

Returns:

the course query

Compliance:

mandatory - This method must be implemented.

getCourseSearchOrder

CourseSearchOrder getCourseSearchOrder()

Gets a course search order.

Returns:

the course search order

Compliance:

mandatory - This method must be implemented.

applyCourseQuery

void applyCourseQuery(CourseQuery courseQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies a course query to this course catalog.

Parameters:

courseQuery - the course query

Throws:

NullArgumentException - courseQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - courseQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCourseQuery

CourseQueryInspector inspectCourseQuery()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a course query inspector for this course catalog.

Returns:

the course query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCourseSequencing

void applyCourseSequencing(CourseSearchOrder courseSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies a course search order to this course catalog.

Parameters:

courseSearchOrder - the course search order

Throws:

NullArgumentException - courseSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - courseSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCourseQueryFromInspector

CourseQuery getCourseQueryFromInspector(CourseQueryInspector courseQueryInspector)

Gets a course query from an inspector.

Parameters:

courseQueryInspector - a query inspector

Returns:

the course query

Throws:

NullArgumentException - courseQueryInspector is null

UnsupportedException - courseQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.