org.osid.course.registration

Interface ActivityBundleCourseCatalogSession

All Superinterfaces:

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

public interface ActivityBundleCourseCatalogSession
extends OsidSession

This session provides methods to retrieve ActivityBundle to CourseCatalog mappings. An ActivityBundle 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	canLookupActivityBundleCourseCatalogMappings() Tests if this user can perform lookups of activity bundle/course catalog mappings.
IdList	getActivityBundleIdsByCourseCatalog(Id courseCatalogId) Gets the list of ActivityBundle Ids associated with a CourseCatalog.
IdList	getActivityBundleIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of ActivityBundle Ids corresponding to a list of CourseCatalog objects.
ActivityBundleList	getActivityBundlesByCourseCatalog(Id courseCatalogId) Gets the list of ActivityBundles associated with a CourseCatalog.
ActivityBundleList	getActivityBundlesByCourseCatalogs(IdList courseCatalogIds) Gets the list of ActivityBundles corresponding to a list of CourseCatalog objects.
IdList	getCourseCatalogIdsByActivityBundle(Id activityBundleId) Gets the CourseCatalog Ids mapped to an ActivityBundle.
CourseCatalogList	getCourseCatalogsByActivityBundle(Id activityBundleId) Gets the CourseCatalog objects mapped to an ActivityBundle.
void	useComparativeActivityBundleCourseCatalogView() 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	usePlenaryActivityBundleCourseCatalogView() A complete view of the ActivityBundle 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

canLookupActivityBundleCourseCatalogMappings

boolean canLookupActivityBundleCourseCatalogMappings()

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

useComparativeActivityBundleCourseCatalogView

void useComparativeActivityBundleCourseCatalogView()

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.

usePlenaryActivityBundleCourseCatalogView

void usePlenaryActivityBundleCourseCatalogView()

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

getActivityBundleIdsByCourseCatalog

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

Gets the list of ActivityBundle Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

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

getActivityBundlesByCourseCatalog

ActivityBundleList getActivityBundlesByCourseCatalog(Id courseCatalogId)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Gets the list of ActivityBundles associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related activity bundles

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.

getActivityBundleIdsByCourseCatalogs

IdList getActivityBundleIdsByCourseCatalogs(IdList courseCatalogIds)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of activity bundle Ids

Throws:

NullArgumentException - courseCatalogIdList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityBundlesByCourseCatalogs

ActivityBundleList getActivityBundlesByCourseCatalogs(IdList courseCatalogIds)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of activity bundles

Throws:

NullArgumentException - courseCatalogIdList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByActivityBundle

IdList getCourseCatalogIdsByActivityBundle(Id activityBundleId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the CourseCatalog Ids mapped to an ActivityBundle.

Parameters:

activityBundleId - Id of an ActivityBundle

Returns:

list of course catalogs

Throws:

NotFoundException - activityBundleId is not found

NullArgumentException - activityBundleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByActivityBundle

CourseCatalogList getCourseCatalogsByActivityBundle(Id activityBundleId)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Gets the CourseCatalog objects mapped to an ActivityBundle.

Parameters:

activityBundleId - Id of an ActivityBundle

Returns:

list of course catalogs

Throws:

NotFoundException - activityBundleId is not found

NullArgumentException - activityBundleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.