org.osid.course.requisite

Interface RequisiteCourseCatalogSession

All Superinterfaces:

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

public interface RequisiteCourseCatalogSession
extends OsidSession

This session provides methods to retrieve Requisite to CourseCatalog mappings. A Requisite 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 requisite/course catalog mappings.
IdList	getCourseCatalogIdsByRequisite(Id requisiteId) Gets the CourseCatalog Ids mapped to a Requisite.
CourseCatalogList	getCourseCatalogsByRequisite(Id requisiteId) Gets the CourseCatalog objects mapped to a Requisite.
IdList	getRequisiteIdsByCourseCatalog(Id courseCatalogId) Gets the list of Requisite Ids associated with a CourseCatalog.
IdList	getRequisiteIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Requisite Ids corresponding to a list of CourseCatalog objects.
RequisiteList	getRequisitesByCourseCatalog(Id courseCatalogId) Gets the list of Requisites associated with a CourseCatalog.
RequisiteList	getRequisitesByCourseCatalogs(IdList courseCatalogIds) Gets the list of Requisites 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 Requisite 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 requisite/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 Requisite 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.

getRequisiteIdsByCourseCatalog

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

Gets the list of Requisite Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

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

getRequisitesByCourseCatalog

RequisiteList getRequisitesByCourseCatalog(Id courseCatalogId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the list of Requisites associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related requisites

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.

getRequisiteIdsByCourseCatalogs

IdList getRequisiteIdsByCourseCatalogs(IdList courseCatalogIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of requisite Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequisitesByCourseCatalogs

RequisiteList getRequisitesByCourseCatalogs(IdList courseCatalogIds)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of requisites

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByRequisite

IdList getCourseCatalogIdsByRequisite(Id requisiteId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the CourseCatalog Ids mapped to a Requisite.

Parameters:

requisiteId - Id of a pRequisite

Returns:

list of course catalog Ids

Throws:

NotFoundException - requisiteId is not found

NullArgumentException - requisiteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByRequisite

CourseCatalogList getCourseCatalogsByRequisite(Id requisiteId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Gets the CourseCatalog objects mapped to a Requisite.

Parameters:

requisiteId - Id of a Requisite

Returns:

list of course catalogs

Throws:

NotFoundException - requisiteId is not found

NullArgumentException - requisiteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.