org.osid.course

Interface TermSmartCourseCatalogSession

All Superinterfaces:

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

public interface TermSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A TermQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Terms. The terms may be sequenced using the TermSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyTermQuery(TermQuery termQuery) Applies a term query to this course catalog.
void	applyTermSequencing(TermSearchOrder termSearchOrder) Applies a term 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.
TermQuery	getTermQuery() Gets a term query.
TermQuery	getTermQueryFromInspector(TermQueryInspector termQueryInspector) Gets a term query from an inspector.
TermSearchOrder	getTermSearchOrder() Gets a term search order.
TermQueryInspector	inspectTermQuery() Gets a term 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.

getTermQuery

TermQuery getTermQuery()

Gets a term query.

Returns:

the term query

Compliance:

mandatory - This method must be implemented.

getTermSearchOrder

TermSearchOrder getTermSearchOrder()

Gets a term search order.

Returns:

the term search order

Compliance:

mandatory - This method must be implemented.

applyTermQuery

void applyTermQuery(TermQuery termQuery)
                    throws OperationFailedException,
                           PermissionDeniedException

Applies a term query to this course catalog.

Parameters:

termQuery - the term query

Throws:

NullArgumentException - termQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - termQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectTermQuery

TermQueryInspector inspectTermQuery()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a term query inspector for this course catalog.

Returns:

the term query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyTermSequencing

void applyTermSequencing(TermSearchOrder termSearchOrder)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a term search order to this course catalog.

Parameters:

termSearchOrder - the term search order

Throws:

NullArgumentException - termSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - termSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getTermQueryFromInspector

TermQuery getTermQueryFromInspector(TermQueryInspector termQueryInspector)

Gets a term query from an inspector.

Parameters:

termQueryInspector - a query inspector

Returns:

the term query

Throws:

NullArgumentException - termQueryInspector is null

UnsupportedException - termQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.