org.osid.course.program

Interface ProgramOfferingSmartCourseCatalogSession

All Superinterfaces:

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

public interface ProgramOfferingSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProgramOfferingQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of ProgramOfferings. The program offerings may be sequenced using the ProgramOfferingSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProgramOfferingQuery(ProgramOfferingQuery programOfferingQuery) Applies a program offering query to this course catalog.
void	applyProgramOfferingSequencing(ProgramOfferingSearchOrder programOfferingSearchOrder) Applies a program offering 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.
ProgramOfferingQuery	getProgramOfferingQuery() Gets a program offering query.
ProgramOfferingQuery	getProgramOfferingQueryFromInspector(ProgramOfferingQueryInspector programOfferingQueryInspector) Gets a program offering query from an inspector.
ProgramOfferingSearchOrder	getProgramOfferingSearchOrder() Gets a program offering search order.
ProgramOfferingQueryInspector	inspectProgramOfferingQuery() Gets a program offering 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.

getProgramOfferingQuery

ProgramOfferingQuery getProgramOfferingQuery()

Gets a program offering query.

Returns:

the program offering query

Compliance:

mandatory - This method must be implemented.

getProgramOfferingSearchOrder

ProgramOfferingSearchOrder getProgramOfferingSearchOrder()

Gets a program offering search order.

Returns:

the program offering search order

Compliance:

mandatory - This method must be implemented.

applyProgramOfferingQuery

void applyProgramOfferingQuery(ProgramOfferingQuery programOfferingQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Applies a program offering query to this course catalog.

Parameters:

programOfferingQuery - the program offering query

Throws:

NullArgumentException - programOfferingQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - programOfferingQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectProgramOfferingQuery

ProgramOfferingQueryInspector inspectProgramOfferingQuery()
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets a program offering query inspector for this course catalog.

Returns:

the program offering query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyProgramOfferingSequencing

void applyProgramOfferingSequencing(ProgramOfferingSearchOrder programOfferingSearchOrder)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Applies a program offering search order to this course catalog.

Parameters:

programOfferingSearchOrder - the program offering search order

Throws:

NullArgumentException - programOfferingSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - programOfferingSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getProgramOfferingQueryFromInspector

ProgramOfferingQuery getProgramOfferingQueryFromInspector(ProgramOfferingQueryInspector programOfferingQueryInspector)

Gets a program offering query from an inspector.

Parameters:

programOfferingQueryInspector - a query inspector

Returns:

the program offering query

Throws:

NullArgumentException - programOfferingQueryInspector is null

UnsupportedException - programOfferingQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.