org.osid.course.registration

Interface RegistrationSmartCourseCatalogSession

All Superinterfaces:

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

public interface RegistrationSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A RegistrationQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Registrations. The registrations may be sequenced using the RegistrationSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyRegistrationQuery(RegistrationQuery registrationQuery) Applies a registration query to this course catalog.
void	applyRegistrationSequencing(RegistrationSearchOrder registrationSearchOrder) Applies a registration 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.
RegistrationQuery	getRegistrationQuery() Gets a registration query.
RegistrationQuery	getRegistrationQueryFromInspector(RegistrationQueryInspector registrationQueryInspector) Gets a registration query from an inspector.
RegistrationSearchOrder	getRegistrationSearchOrder() Gets a registration search order.
RegistrationQueryInspector	inspectRegistrationQuery() Gets a registration 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.

getRegistrationQuery

RegistrationQuery getRegistrationQuery()

Gets a registration query.

Returns:

the registration query

Compliance:

mandatory - This method must be implemented.

getRegistrationSearchOrder

RegistrationSearchOrder getRegistrationSearchOrder()

Gets a registration search order.

Returns:

the registration search order

Compliance:

mandatory - This method must be implemented.

applyRegistrationQuery

void applyRegistrationQuery(RegistrationQuery registrationQuery)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a registration query to this course catalog.

Parameters:

registrationQuery - the registration query

Throws:

NullArgumentException - registrationQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - registrationQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRegistrationQuery

RegistrationQueryInspector inspectRegistrationQuery()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a registration query inspector for this course catalog.

Returns:

the registration query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRegistrationSequencing

void applyRegistrationSequencing(RegistrationSearchOrder registrationSearchOrder)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies a registration search order to this course catalog.

Parameters:

registrationSearchOrder - the registration search order

Throws:

NullArgumentException - registrationSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - registrationSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRegistrationQueryFromInspector

RegistrationQuery getRegistrationQueryFromInspector(RegistrationQueryInspector registrationQueryInspector)

Gets a registration query from an inspector.

Parameters:

registrationQueryInspector - a query inspector

Returns:

the registration query

Throws:

NullArgumentException - registrationQueryInspector is null

UnsupportedException - registrationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.