org.osid.course

Interface ActivitySmartCourseCatalogSession

All Superinterfaces:

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

public interface ActivitySmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An ActivityQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Activities. The activities may be sequenced using the ActivitySearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyActivityQuery(ActivityQuery activityQuery) Applies an activity query to this course catalog.
void	applyActivitySequencing(ActivitySearchOrder activitySearchOrder) Applies an activity search order to this course catalog.
boolean	canManageSmartCourseCatalogs() Tests if this user can manage smart course catalogs.
ActivityQuery	getActivityQuery() Gets an activity query.
ActivityQuery	getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector) Gets an activity query from an inspector.
ActivitySearchOrder	getActivitySearchOrder() Gets an activity search order.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
ActivityQueryInspector	inspectActivityQuery() Gets an activity 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.

getActivityQuery

ActivityQuery getActivityQuery()

Gets an activity query.

Returns:

the activity query

Compliance:

mandatory - This method must be implemented.

getActivitySearchOrder

ActivitySearchOrder getActivitySearchOrder()

Gets an activity search order.

Returns:

the activity search order

Compliance:

mandatory - This method must be implemented.

applyActivityQuery

void applyActivityQuery(ActivityQuery activityQuery)
                        throws OperationFailedException,
                               PermissionDeniedException

Applies an activity query to this course catalog.

Parameters:

activityQuery - the activity query

Throws:

NullArgumentException - activityQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - activityQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectActivityQuery

ActivityQueryInspector inspectActivityQuery()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets an activity query inspector for this course catalog.

Returns:

the activity query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyActivitySequencing

void applyActivitySequencing(ActivitySearchOrder activitySearchOrder)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies an activity search order to this course catalog.

Parameters:

activitySearchOrder - the activity search order

Throws:

NullArgumentException - activitySearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - activitySearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getActivityQueryFromInspector

ActivityQuery getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector)

Gets an activity query from an inspector.

Parameters:

activityQueryInspector - a query inspector

Returns:

the activity query

Throws:

NullArgumentException - activityQueryInspector is null

UnsupportedException - activityQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.