Interface PlanCourseCatalogSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PlanCourseCatalogSession
extends OsidSession

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

Modifier and Type	Method	Description
boolean	canLookupPlanCourseCatalogMappings()	Tests if this user can perform lookups of plan/course catalog mappings.
IdList	getCourseCatalogIdsByPlan(Id planId)	Gets the list of CourseCatalog Ids mapped to a Plan .
CourseCatalogList	getCourseCatalogsByPlan(Id planId)	Gets the list of CourseCatalog objects mapped to a Plan .
IdList	getPlanIdsByCourseCatalog(Id courseCatalogId)	Gets the list of Plan Ids associated with an CourseCatalog .
IdList	getPlanIdsByCourseCatalogs(IdList courseCatalogIds)	Gets the list of Plan Ids corresponding to a list of CourseCatalog objects.
PlanList	getPlansByCourseCatalog(Id courseCatalogId)	Gets the list of Plans associated with an CourseCatalog .
PlanList	getPlansByCourseCatalogs(IdList courseCatalogIds)	Gets the list of Plans 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 Plan 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

canLookupPlanCourseCatalogMappings

boolean canLookupPlanCourseCatalogMappings()

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

getPlanIdsByCourseCatalog

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

Gets the list of Plan Ids associated with an CourseCatalog .

Parameters:

courseCatalogId - Id of an CourseCatalog .

Returns:

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

getPlansByCourseCatalog

PlanList getPlansByCourseCatalog(Id courseCatalogId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Plans associated with an CourseCatalog .

Parameters:

courseCatalogId - Id of an CourseCatalog

Returns:

list of related plans

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.

getPlanIdsByCourseCatalogs

IdList getPlanIdsByCourseCatalogs(IdList courseCatalogIds)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of plan Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPlansByCourseCatalogs

PlanList getPlansByCourseCatalogs(IdList courseCatalogIds)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of plans

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByPlan

IdList getCourseCatalogIdsByPlan(Id planId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of CourseCatalog Ids mapped to a Plan .

Parameters:

planId - Id of a Plan

Returns:

list of course catalog Ids

Throws:

NotFoundException - planId is not found

NullArgumentException - planId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByPlan

CourseCatalogList getCourseCatalogsByPlan(Id planId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of CourseCatalog objects mapped to a Plan .

Parameters:

planId - Id of a Plan

Returns:

list of course catalogs

Throws:

NotFoundException - planId is not found

NullArgumentException - planId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.