org.osid.course.chronicle

Interface CourseEntryCourseCatalogSession

All Superinterfaces:

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

public interface CourseEntryCourseCatalogSession
extends OsidSession

This session provides methods to retrieve CourseEntry to CourseCatalog mappings. A CourseEntry may appear in multiple CourseCatalog objects. Each catalog 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	canLookupCourseCatalogMappings() Tests if this user can perform lookups of course entry/course catalog mappings.
IdList	getCourseCatalogIdsByCourseEntry(Id courseEntryId) Gets the CourseCatalog Ids mapped to a CourseEntry.
CourseCatalogList	getCourseCatalogsByCourseEntry(Id courseEntryId) Gets the CourseCatalog objects mapped to a CourseEntry.
CourseEntryList	getCourseEntriesByCourseCatalog(Id courseCatalogId) Gets the list of CourseEntries associated with a CourseCatalog.
CourseEntryList	getCourseEntriesByCourseCatalogs(IdList courseCatalogIds) Gets the list of CourseEntries corresponding to a list of CourseCatalog objects.
IdList	getCourseEntryIdsByCourseCatalog(Id courseCatalogId) Gets the list of CourseEntry Ids associated with a CourseCatalog.
IdList	getCourseEntryIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of CourseEntry Ids corresponding to a list of CourseCatalog objects.
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 CourseEntry 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

canLookupCourseCatalogMappings

boolean canLookupCourseCatalogMappings()

Tests if this user can perform lookups of course entry/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 intended as 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 CourseEntry 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.

getCourseEntryIdsByCourseCatalog

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

Gets the list of CourseEntry Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

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

getCourseEntriesByCourseCatalog

CourseEntryList getCourseEntriesByCourseCatalog(Id courseCatalogId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the list of CourseEntries associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related course entries

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.

getCourseEntryIdsByCourseCatalogs

IdList getCourseEntryIdsByCourseCatalogs(IdList courseCatalogIds)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of course entry Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseEntriesByCourseCatalogs

CourseEntryList getCourseEntriesByCourseCatalogs(IdList courseCatalogIds)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets the list of CourseEntries corresponding to a list of CourseCatalog objects.

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of coursee ntries

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByCourseEntry

IdList getCourseCatalogIdsByCourseEntry(Id courseEntryId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the CourseCatalog Ids mapped to a CourseEntry.

Parameters:

courseEntryId - Id of a pCourseEntry

Returns:

list of course catalog Ids

Throws:

NotFoundException - courseEntryId is not found

NullArgumentException - courseEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByCourseEntry

CourseCatalogList getCourseCatalogsByCourseEntry(Id courseEntryId)
                                                 throws NotFoundException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Gets the CourseCatalog objects mapped to a CourseEntry.

Parameters:

courseEntryId - Id of a CourseEntry

Returns:

list of course catalogs

Throws:

NotFoundException - courseEntryId is not found

NullArgumentException - courseEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.