org.osid.course.program

Interface ProgramOfferingCourseCatalogSession

All Superinterfaces:

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

public interface ProgramOfferingCourseCatalogSession
extends OsidSession

This session provides methods to retrieve ProgramOffering to CourseCatalog mappings. A ProgramOffering 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	canLookupProgramOfferingCourseCatalogMappings() Tests if this user can perform lookups of program offering/course catalog mappings.
IdList	getCourseCatalogIdsByProgramOffering(Id programOfferingId) Gets the CourseCatalog Ids mapped to a ProgramOffering.
CourseCatalogList	getCourseCatalogsByProgramOffering(Id programOfferingId) Gets the CourseCatalogs mapped to a ProgramOffering.
IdList	getProgramOfferingIdsByCourseCatalog(Id courseCatalogId) Gets the list of ProgramOffering Ids associated with a CourseCatalog.
IdList	getProgramOfferingIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of ProgramOffering Ids corresponding to a list of CourseCatalog objects.
ProgramOfferingList	getProgramOfferingsByCourseCatalog(Id courseCatalogId) Gets the list of ProgramOfferings associated with a CourseCatalog.
ProgramOfferingList	getProgramOfferingsByCourseCatalogs(IdList courseCatalogIds) Gets the list of ProgramOfferings corresponding to a list of CourseCatalog objects.
void	useComparativeProgramOfferingCourseCatalogView() 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	usePlenaryProgramOfferingCourseCatalogView() A complete view of the ProgramOffering 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

canLookupProgramOfferingCourseCatalogMappings

boolean canLookupProgramOfferingCourseCatalogMappings()

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

useComparativeProgramOfferingCourseCatalogView

void useComparativeProgramOfferingCourseCatalogView()

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.

usePlenaryProgramOfferingCourseCatalogView

void usePlenaryProgramOfferingCourseCatalogView()

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

getProgramOfferingIdsByCourseCatalog

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

Gets the list of ProgramOffering Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

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

getProgramOfferingsByCourseCatalog

ProgramOfferingList getProgramOfferingsByCourseCatalog(Id courseCatalogId)
                                                       throws NotFoundException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Gets the list of ProgramOfferings associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related program offerings

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.

getProgramOfferingIdsByCourseCatalogs

IdList getProgramOfferingIdsByCourseCatalogs(IdList courseCatalogIds)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of program offering Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsByCourseCatalogs

ProgramOfferingList getProgramOfferingsByCourseCatalogs(IdList courseCatalogIds)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of program offerings

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByProgramOffering

IdList getCourseCatalogIdsByProgramOffering(Id programOfferingId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the CourseCatalog Ids mapped to a ProgramOffering.

Parameters:

programOfferingId - Id of a ProgramOffering

Returns:

list of course catalogs

Throws:

NotFoundException - programOfferingId is not found

NullArgumentException - programOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByProgramOffering

CourseCatalogList getCourseCatalogsByProgramOffering(Id programOfferingId)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Gets the CourseCatalogs mapped to a ProgramOffering.

Parameters:

programOfferingId - Id of a ProgramOffering

Returns:

list of course catalogs

Throws:

NotFoundException - programOfferingId is not found

NullArgumentException - programOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.