org.osid.course

Interface TermCourseCatalogSession

All Superinterfaces:

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

public interface TermCourseCatalogSession
extends OsidSession

This session provides methods to retrieve Term to CourseCatalog mappings. A Term 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	canLookupTermCourseCatalogMappings() Tests if this user can perform lookups of term/course catalog mappings.
IdList	getCourseCatalogIdsByTerm(Id termId) Gets the CourseCatalog Ids mapped to a Term.
CourseCatalogList	getCourseCatalogsByTerm(Id termId) Gets the CourseCatalog objects mapped to a Term.
IdList	getTermIdsByCourseCatalog(Id courseCatalogId) Gets the list of Term Ids associated with a CourseCatalog.
IdList	getTermIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Term Ids corresponding to a list of CourseCatalog objects.
TermList	getTermsByCourseCatalog(Id courseCatalogId) Gets the list of Term associated with a CourseCatalog.
TermList	getTermsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Terms corresponding to a list of CourseCatalog objects.
void	useComparativeTermCourseCatalogView() 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	usePlenaryTermCatalogView() A complete view of the Term 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

canLookupTermCourseCatalogMappings

boolean canLookupTermCourseCatalogMappings()

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

useComparativeTermCourseCatalogView

void useComparativeTermCourseCatalogView()

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.

usePlenaryTermCatalogView

void usePlenaryTermCatalogView()

A complete view of the Term 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.

getTermIdsByCourseCatalog

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

Gets the list of Term Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

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

getTermsByCourseCatalog

TermList getTermsByCourseCatalog(Id courseCatalogId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the list of Term associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related terms

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.

getTermIdsByCourseCatalogs

IdList getTermIdsByCourseCatalogs(IdList courseCatalogIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

courseCatalogIds - list of catalog Ids

Returns:

list of term Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTermsByCourseCatalogs

TermList getTermsByCourseCatalogs(IdList courseCatalogIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

courseCatalogIds - list of catalog Ids

Returns:

list of terms

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByTerm

IdList getCourseCatalogIdsByTerm(Id termId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the CourseCatalog Ids mapped to a Term.

Parameters:

termId - Id of a Term

Returns:

list of course catalogs

Throws:

NotFoundException - termId is not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByTerm

CourseCatalogList getCourseCatalogsByTerm(Id termId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the CourseCatalog objects mapped to a Term.

Parameters:

termId - Id of a Term

Returns:

list of course catalogs

Throws:

NotFoundException - termId is not found

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.