org.osid.course.program

Interface ProgramSmartCourseCatalogSession

All Superinterfaces:

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

public interface ProgramSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProgramQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Programs. The courses may be sequenced using the ProgramSearchOrder 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 ProgramQueryInspector. The query may be modified by converting the inspector back to a ProgramQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProgramQuery(ProgramQuery programQuery) Applies a program query to this course catalog.
void	applyProgramSequencing(ProgramSearchOrder programSearchOrder) Applies a program 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.
ProgramQuery	getProgramQuery() Gets a program query.
ProgramQuery	getProgramQueryFromInspector(ProgramQueryInspector programQueryInspector) Gets a program query from an inspector.
ProgramSearchOrder	getProgramSearchOrder() Gets a program search order.
ProgramQueryInspector	inspectProgramQuery() Gets a program 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.

getProgramQuery

ProgramQuery getProgramQuery()

Gets a program query.

Returns:

the program query

Compliance:

mandatory - This method must be implemented.

getProgramSearchOrder

ProgramSearchOrder getProgramSearchOrder()

Gets a program search order.

Returns:

the program search order

Compliance:

mandatory - This method must be implemented.

applyProgramQuery

void applyProgramQuery(ProgramQuery programQuery)
                       throws OperationFailedException,
                              PermissionDeniedException

Applies a program query to this course catalog.

Parameters:

programQuery - the program query

Throws:

NullArgumentException - programQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - programQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectProgramQuery

ProgramQueryInspector inspectProgramQuery()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a program query inspector for this course catalog.

Returns:

the program query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyProgramSequencing

void applyProgramSequencing(ProgramSearchOrder programSearchOrder)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a program search order to this course catalog.

Parameters:

programSearchOrder - the program search order

Throws:

NullArgumentException - programSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - programSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getProgramQueryFromInspector

ProgramQuery getProgramQueryFromInspector(ProgramQueryInspector programQueryInspector)

Gets a program query from an inspector.

Parameters:

programQueryInspector - a query inspector

Returns:

the program query

Throws:

NullArgumentException - programQueryInspector is null

UnsupportedException - programQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.