org.osid.course.plan

Interface LessonSmartCourseCatalogSession

All Superinterfaces:

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

public interface LessonSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A LessonQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Lessons. The lessonsmay be sequenced using the LessonSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyLessonQuery(LessonQuery lessonQuery) Applies a lesson query to this course catalog.
void	applyLessonSequencing(LessonSearchOrder lessonSearchOrder) Applies a lesson 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.
LessonQuery	getLessonQuery() Gets a lesson query.
LessonQuery	getLessonQueryFromInspector(LessonQueryInspector lessonQueryInspector) Gets a lesson query from an inspector.
LessonSearchOrder	getLessonSearchOrder() Gets a lesson search order.
LessonQueryInspector	inspectLessonQuery() Gets a lesson 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 CourseCatalog associated with this session

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 authorization. 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.

getLessonQuery

LessonQuery getLessonQuery()

Gets a lesson query.

Returns:

the lesson query

Compliance:

mandatory - This method must be implemented.

getLessonSearchOrder

LessonSearchOrder getLessonSearchOrder()

Gets a lesson search order.

Returns:

the lesson search order

Compliance:

mandatory - This method must be implemented.

applyLessonQuery

void applyLessonQuery(LessonQuery lessonQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies a lesson query to this course catalog.

Parameters:

lessonQuery - the lesson query

Throws:

NullArgumentException - lessonQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - lessonQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectLessonQuery

LessonQueryInspector inspectLessonQuery()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a lesson query inspector for this course catalog.

Returns:

the lesson query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyLessonSequencing

void applyLessonSequencing(LessonSearchOrder lessonSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies a lesson search order to this course catalog.

Parameters:

lessonSearchOrder - the lesson search order

Throws:

NullArgumentException - lessonSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - lessonSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getLessonQueryFromInspector

LessonQuery getLessonQueryFromInspector(LessonQueryInspector lessonQueryInspector)

Gets a lesson query from an inspector.

Parameters:

lessonQueryInspector - a query inspector

Returns:

the lesson query

Throws:

NullArgumentException - lessonQueryInspector is null

UnsupportedException - lessonQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.