org.osid.course.plan

Interface LessonCourseCatalogSession

All Superinterfaces:

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

public interface LessonCourseCatalogSession
extends OsidSession

This session provides methods to retrieve Lesson to CourseCatalog mappings. A Lesson 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	canLookupLessonCourseCatalogMappings() Tests if this user can perform lookups of lesson/course catalog mappings.
IdList	getCourseCatalogIdsByLesson(Id lessonId) Gets the list of CourseCatalog Ids mapped to a Lesson.
CourseCatalogList	getCourseCatalogsByLesson(Id lessonId) Gets the list of CourseCatalog objects mapped to a Lesson.
IdList	getLessonIdsByCourseCatalog(Id courseCatalogId) Gets the list of Lesson Ids associated with an CourseCatalog.
IdList	getLessonIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Lesson Ids corresponding to a list of CourseCatalog objects.
LessonList	getLessonsByCourseCatalog(Id courseCatalogId) Gets the list of Lessons associated with an CourseCatalog.
LessonList	getLessonsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Lessons 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 Lesson 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

canLookupLessonCourseCatalogMappings

boolean canLookupLessonCourseCatalogMappings()

Tests if this user can perform lookups of lesson/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 Lesson 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.

getLessonIdsByCourseCatalog

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

Gets the list of Lesson Ids associated with an CourseCatalog.

Parameters:

courseCatalogId - Id of an CourseCatalog.

Returns:

list of related lesson 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.

getLessonsByCourseCatalog

LessonList getLessonsByCourseCatalog(Id courseCatalogId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the list of Lessons associated with an CourseCatalog.

Parameters:

courseCatalogId - Id of an CourseCatalog

Returns:

list of related lessons

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.

getLessonIdsByCourseCatalogs

IdList getLessonIdsByCourseCatalogs(IdList courseCatalogIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of lesson Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLessonsByCourseCatalogs

LessonList getLessonsByCourseCatalogs(IdList courseCatalogIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of lessons

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByLesson

IdList getCourseCatalogIdsByLesson(Id lessonId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the list of CourseCatalog Ids mapped to a Lesson.

Parameters:

lessonId - Id of a Lesson

Returns:

list of course catalog Ids

Throws:

NotFoundException - lessonId is not found

NullArgumentException - lessonId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByLesson

CourseCatalogList getCourseCatalogsByLesson(Id lessonId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the list of CourseCatalog objects mapped to a Lesson.

Parameters:

lessonId - Id of a Lesson

Returns:

list of course catalogs

Throws:

NotFoundException - lessonId is not found

NullArgumentException - lessonId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.