org.osid.course.registration

Interface ActivityBundleSmartCourseCatalogSession

All Superinterfaces:

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

public interface ActivityBundleSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An ActivityBundleQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of ActivityBundles. The activity bundles may be sequenced using the ActivityBundleSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyActivityBundleQuery(ActivityBundleQuery activityBundleQuery) Applies an activity bundle query to this course catalog.
void	applyActivityBundleSequencing(ActivityBundleSearchOrder activityBundleSearchOrder) Applies an activity bundle search order to this course catalog.
boolean	canManageSmartCourseCatalogs() Tests if this user can manage smart course catalogs.
ActivityBundleQuery	getActivityBundleQuery() Gets an activity bundle query.
ActivityBundleQuery	getActivityBundleQueryFromInspector(ActivityBundleQueryInspector activityBundleQueryInspector) Gets an activity bundle query from an inspector.
ActivityBundleSearchOrder	getActivityBundleSearchOrder() Gets an activity bundle search order.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
ActivityBundleQueryInspector	inspectActivityBundleQuery() Gets an activity bundle 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.

getActivityBundleQuery

ActivityBundleQuery getActivityBundleQuery()

Gets an activity bundle query.

Returns:

the activity bundle query

Compliance:

mandatory - This method must be implemented.

getActivityBundleSearchOrder

ActivityBundleSearchOrder getActivityBundleSearchOrder()

Gets an activity bundle search order.

Returns:

the activity bundle search order

Compliance:

mandatory - This method must be implemented.

applyActivityBundleQuery

void applyActivityBundleQuery(ActivityBundleQuery activityBundleQuery)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies an activity bundle query to this course catalog.

Parameters:

activityBundleQuery - the activity bundle query

Throws:

NullArgumentException - activityBundleQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - activityBundleQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectActivityBundleQuery

ActivityBundleQueryInspector inspectActivityBundleQuery()
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets an activity bundle query inspector for this course catalog.

Returns:

the activity bundle query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyActivityBundleSequencing

void applyActivityBundleSequencing(ActivityBundleSearchOrder activityBundleSearchOrder)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies an activity bundle search order to this course catalog.

Parameters:

activityBundleSearchOrder - the activity bundle search order

Throws:

NullArgumentException - activityBundleSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - activityBundleSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getActivityBundleQueryFromInspector

ActivityBundleQuery getActivityBundleQueryFromInspector(ActivityBundleQueryInspector activityBundleQueryInspector)

Gets an activity bundle query from an inspector.

Parameters:

activityBundleQueryInspector - a query inspector

Returns:

the activity bundle query

Throws:

NullArgumentException - activityBundleQueryInspector is null

UnsupportedException - activityBundleQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.