org.osid.course.syllabus

Interface SyllabusSmartCourseCatalogSession

All Superinterfaces:

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

public interface SyllabusSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A SyllabusQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Syllabi. The docetsmay be sequenced using the SyllabusSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applySyllabusQuery(SyllabusQuery syllabusQuery) Applies a syllabus query to this course catalog.
void	applySyllabusSequencing(SyllabusSearchOrder syllabusSearchOrder) Applies a syllabus 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.
SyllabusQuery	getSyllabusQuery() Gets a syllabus query.
SyllabusQuery	getSyllabusQueryFromInspector(SyllabusQueryInspector syllabusQueryInspector) Gets a syllabus query from an inspector.
SyllabusSearchOrder	getSyllabusSearchOrder() Gets a syllabus search order.
SyllabusQueryInspector	inspectSyllabusQuery() Gets a syllabus 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.

getSyllabusQuery

SyllabusQuery getSyllabusQuery()

Gets a syllabus query.

Returns:

the syllabus query

Compliance:

mandatory - This method must be implemented.

getSyllabusSearchOrder

SyllabusSearchOrder getSyllabusSearchOrder()

Gets a syllabus search order.

Returns:

the syllabus search order

Compliance:

mandatory - This method must be implemented.

applySyllabusQuery

void applySyllabusQuery(SyllabusQuery syllabusQuery)
                        throws OperationFailedException,
                               PermissionDeniedException

Applies a syllabus query to this course catalog.

Parameters:

syllabusQuery - the syllabus query

Throws:

NullArgumentException - syllabusQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - syllabusQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSyllabusQuery

SyllabusQueryInspector inspectSyllabusQuery()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a syllabus query inspector for this course catalog.

Returns:

the syllabus query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySyllabusSequencing

void applySyllabusSequencing(SyllabusSearchOrder syllabusSearchOrder)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a syllabus search order to this course catalog.

Parameters:

syllabusSearchOrder - the syllabus search order

Throws:

NullArgumentException - syllabusSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - syllabusSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSyllabusQueryFromInspector

SyllabusQuery getSyllabusQueryFromInspector(SyllabusQueryInspector syllabusQueryInspector)

Gets a syllabus query from an inspector.

Parameters:

syllabusQueryInspector - a query inspector

Returns:

the syllabus query

Throws:

NullArgumentException - syllabusQueryInspector is null

UnsupportedException - syllabusQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.