org.osid.course.syllabus

Interface DocetCourseCatalogSession

All Superinterfaces:

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

public interface DocetCourseCatalogSession
extends OsidSession

This session provides methods to retrieve Docet to CourseCatalog mappings. An Docet 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	canLookupDocetCourseCatalogMappings() Tests if this user can perform lookups of docet/course catalog mappings.
IdList	getCourseCatalogIdsByDocet(Id docetId) Gets the list of CourseCatalog Ids mapped to an Docet.
CourseCatalogList	getCourseCatalogsByDocet(Id docetId) Gets the list of CourseCatalog objects mapped to an Docet.
IdList	getDocetIdsByCourseCatalog(Id courseCatalogId) Gets the list of Docet Ids associated with an CourseCatalog.
IdList	getDocetIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Docet Ids corresponding to a list of CourseCatalog objects.
DocetList	getDocetsByCourseCatalog(Id courseCatalogId) Gets the list of Docets associated with an CourseCatalog.
DocetList	getDocetsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Docets 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 Docet 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

canLookupDocetCourseCatalogMappings

boolean canLookupDocetCourseCatalogMappings()

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

getDocetIdsByCourseCatalog

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

Gets the list of Docet Ids associated with an CourseCatalog.

Parameters:

courseCatalogId - Id of an CourseCatalog.

Returns:

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

getDocetsByCourseCatalog

DocetList getDocetsByCourseCatalog(Id courseCatalogId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the list of Docets associated with an CourseCatalog.

Parameters:

courseCatalogId - Id of an CourseCatalog

Returns:

list of related docets

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.

getDocetIdsByCourseCatalogs

IdList getDocetIdsByCourseCatalogs(IdList courseCatalogIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of docet Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDocetsByCourseCatalogs

DocetList getDocetsByCourseCatalogs(IdList courseCatalogIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of docets

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByDocet

IdList getCourseCatalogIdsByDocet(Id docetId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the list of CourseCatalog Ids mapped to an Docet.

Parameters:

docetId - Id of an Docet

Returns:

list of course catalog Ids

Throws:

NotFoundException - docetId is not found

NullArgumentException - docetId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByDocet

CourseCatalogList getCourseCatalogsByDocet(Id docetId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the list of CourseCatalog objects mapped to an Docet.

Parameters:

docetId - Id of an Docet

Returns:

list of course catalogs

Throws:

NotFoundException - docetId is not found

NullArgumentException - docetId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.