Interface TermCourseCatalogSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TermCourseCatalogSession
extends OsidSession

This session provides methods to retrieve Term to CourseCatalog mappings. A Term may appear in multiple CourseCatalogs . 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.