org.osid.course.registration

Interface ActivityBundleCourseCatalogAssignmentSession

All Superinterfaces:

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

public interface ActivityBundleCourseCatalogAssignmentSession
extends OsidSession

This session provides methods to re-assign ActivityBundles to CourseCatalog objects An ActivityBundle may appear in multiple CourseCatalog objects and removing the last reference to an ActivityBundle is the equivalent of deleting it. Each CourseCatalog may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an ActivityBundle to another CourseCatalog is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignActivityBundleToCourseCatalog(Id activityBundleId, Id courseCatalogId) Adds an existing ActivityBundle to a CourseCatalog.
boolean	canAssignActivityBundles() Tests if this user can alter activity bundle/course catalog mappings.
boolean	canAssignActivityBundleToCourseCatalog(Id courseCatalogId) Tests if this user can alter activity bundle/course catalog mappings.
IdList	getAssignableCourseCatalogIds(Id courseCatalogId) Gets a list of course catalogs including and under the given course catalog node in which any activity bundle can be assigned.
IdList	getAssignableCourseCatalogIdsForActivityBundle(Id courseCatalogId, Id activityBundleId) Gets a list of course catalogs including and under the given course catalog node in which a specific activity bundle can be assigned.
void	unassignActivityBundleFromCourseCatalog(Id activityBundleId, Id courseCatalogId) Removes an ActivityBundle from a CourseCatalog.

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

canAssignActivityBundles

boolean canAssignActivityBundles()

Tests if this user can alter activity bundle/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignActivityBundleToCourseCatalog

boolean canAssignActivityBundleToCourseCatalog(Id courseCatalogId)

Tests if this user can alter activity bundle/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - courseCatalogId is null

Compliance:

mandatory - This method must be implemented.

getAssignableCourseCatalogIds

IdList getAssignableCourseCatalogIds(Id courseCatalogId)
                                     throws OperationFailedException

Gets a list of course catalogs including and under the given course catalog node in which any activity bundle can be assigned.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

list of assignable course catalog Ids

Throws:

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableCourseCatalogIdsForActivityBundle

IdList getAssignableCourseCatalogIdsForActivityBundle(Id courseCatalogId,
                                                    Id activityBundleId)
                                                      throws OperationFailedException

Gets a list of course catalogs including and under the given course catalog node in which a specific activity bundle can be assigned.

Parameters:

courseCatalogId - the Id of the CourseCatalog

activityBundleId - the Id of the ActivityBundle

Returns:

list of assignable course catalog Ids

Throws:

NullArgumentException - courseCatalogId or activityBundleId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignActivityBundleToCourseCatalog

void assignActivityBundleToCourseCatalog(Id activityBundleId,
                                       Id courseCatalogId)
                                         throws AlreadyExistsException,
                                                NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Adds an existing ActivityBundle to a CourseCatalog.

Parameters:

activityBundleId - the Id of the ActivityBundle

courseCatalogId - the Id of the CourseCatalog

Throws:

AlreadyExistsException - activityBundleId is already assigned to courseCatalogId

NotFoundException - activityBundleId or courseCatalogId not found

NullArgumentException - activityBundleId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignActivityBundleFromCourseCatalog

void unassignActivityBundleFromCourseCatalog(Id activityBundleId,
                                           Id courseCatalogId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Removes an ActivityBundle from a CourseCatalog.

Parameters:

activityBundleId - the Id of the ActivityBundle

courseCatalogId - the Id of the CourseCatalog

Throws:

NotFoundException - activityBundleId or courseCatalogId not found activityBundleId not assigned to courseCatalogId

NullArgumentException - activityBundleId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.