org.osid.course.syllabus

Interface DocetSmartCourseCatalogSession

All Superinterfaces:

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

public interface DocetSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An DocetQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Docets. The docetsmay be sequenced using the DocetSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyDocetQuery(DocetQuery docetQuery) Applies a docet query to this course catalog.
void	applyDocetSequencing(DocetSearchOrder docetSearchOrder) Applies a docet 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.
DocetQuery	getDocetQuery() Gets a docet query.
DocetQuery	getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector) Gets a docet query from an inspector.
DocetSearchOrder	getDocetSearchOrder() Gets a docet search order.
DocetQueryInspector	inspectDocetQuery() Gets a docet 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.

getDocetQuery

DocetQuery getDocetQuery()

Gets a docet query.

Returns:

the docet query

Compliance:

mandatory - This method must be implemented.

getDocetSearchOrder

DocetSearchOrder getDocetSearchOrder()

Gets a docet search order.

Returns:

the docet search order

Compliance:

mandatory - This method must be implemented.

applyDocetQuery

void applyDocetQuery(DocetQuery docetQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies a docet query to this course catalog.

Parameters:

docetQuery - the docet query

Throws:

NullArgumentException - docetQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - docetQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectDocetQuery

DocetQueryInspector inspectDocetQuery()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a docet query inspector for this course catalog.

Returns:

the docet query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyDocetSequencing

void applyDocetSequencing(DocetSearchOrder docetSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a docet search order to this course catalog.

Parameters:

docetSearchOrder - the docet search order

Throws:

NullArgumentException - docetSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - docetSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getDocetQueryFromInspector

DocetQuery getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector)

Gets a docet query from an inspector.

Parameters:

docetQueryInspector - a query inspector

Returns:

the docet query

Throws:

NullArgumentException - docetQueryInspector is null

UnsupportedException - docetQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.