org.osid.course.syllabus

Interface ModuleCourseCatalogSession

All Superinterfaces:

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

public interface ModuleCourseCatalogSession
extends OsidSession

This session provides methods to retrieve Module to CourseCatalog mappings. A Module may appear in multiple Course Catalogs. Each CourseCatalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupModuleCourseCatalogMappings() Tests if this user can perform lookups of module/course catalog mappings.
IdList	getCourseCatalogIdsByModule(Id moduleId) Gets the list of CourseCatalog Ids mapped to a Module.
CourseCatalogList	getCourseCatalogsByModule(Id moduleId) Gets the list of CourseCatalog objects mapped to a Module.
IdList	getModuleIdsByCourseCatalog(Id courseCatalogId) Gets the list of Module Ids associated with an CourseCatalog.
IdList	getModuleIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Module Ids corresponding to a list of CourseCatalog objects.
ModuleList	getModulesByCourseCatalog(Id courseCatalogId) Gets the list of Modules associated with an CourseCatalog.
ModuleList	getModulesByCourseCatalogs(IdList courseCatalogIds) Gets the list of Modules corresponding to a list of Course Catalogs.
void	useComparativeCourseCatalogView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCourseCatalogView() A complete view of the Module and CourseCatalog returns is desired.

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

canLookupModuleCourseCatalogMappings

boolean canLookupModuleCourseCatalogMappings()

Tests if this user can perform lookups of module/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCourseCatalogView

void useComparativeCourseCatalogView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryCourseCatalogView

void usePlenaryCourseCatalogView()

A complete view of the Module and CourseCatalog returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getModuleIdsByCourseCatalog

IdList getModuleIdsByCourseCatalog(Id courseCatalogId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the list of Module Ids associated with an CourseCatalog.

Parameters:

courseCatalogId - Id of an CourseCatalog.

Returns:

list of related module Ids

Throws:

NotFoundException - courseCatalogId is not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getModulesByCourseCatalog

ModuleList getModulesByCourseCatalog(Id courseCatalogId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the list of Modules associated with an CourseCatalog.

Parameters:

courseCatalogId - Id of an CourseCatalog

Returns:

list of related modules

Throws:

NotFoundException - courseCatalogId is not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getModuleIdsByCourseCatalogs

IdList getModuleIdsByCourseCatalogs(IdList courseCatalogIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets the list of Module Ids corresponding to a list of CourseCatalog objects.

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of module Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getModulesByCourseCatalogs

ModuleList getModulesByCourseCatalogs(IdList courseCatalogIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets the list of Modules corresponding to a list of Course Catalogs.

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of modules

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByModule

IdList getCourseCatalogIdsByModule(Id moduleId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the list of CourseCatalog Ids mapped to a Module.

Parameters:

moduleId - Id of a Module

Returns:

list of course catalog Ids

Throws:

NotFoundException - moduleId is not found

NullArgumentException - moduleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByModule

CourseCatalogList getCourseCatalogsByModule(Id moduleId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the list of CourseCatalog objects mapped to a Module.

Parameters:

moduleId - Id of a Module

Returns:

list of course catalogs

Throws:

NotFoundException - moduleId is not found

NullArgumentException - moduleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.