org.osid.course.syllabus

Interface ModuleQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

ModuleSearchSession

public interface ModuleQuerySession
extends OsidSession

This session provides methods for searching Module objects. The search query is constructed using the ModuleQuery. The docet record Type also specifies the record for the docet query.

Modules may have a query record indicated by their respective record types. The query record is accessed via the ModuleQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchModules() Tests if this user can perform susbcription searches.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
ModuleQuery	getModuleQuery() Gets a module query.
ModuleList	getModulesByQuery(ModuleQuery moduleQuery) Gets a list of modules matching the given module query.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.

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.

canSearchModules

boolean canSearchModules()

Tests if this user can perform susbcription searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include modules in course catalogs which are children of this course catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

getModuleQuery

ModuleQuery getModuleQuery()

Gets a module query.

Returns:

the module query

Compliance:

mandatory - This method must be implemented.

getModulesByQuery

ModuleList getModulesByQuery(ModuleQuery moduleQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets a list of modules matching the given module query.

Parameters:

moduleQuery - the module query

Returns:

the returned ModuleList

Throws:

NullArgumentException - moduleQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - moduleQuery is not of this service

Compliance:

mandatory - This method must be implemented.