org.osid.course

Interface CourseOfferingCourseCatalogAssignmentSession

All Superinterfaces:

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

public interface CourseOfferingCourseCatalogAssignmentSession
extends OsidSession

This session provides methods to re-assign CourseOfferings to CourseCatalog objects A CourseOffering may appear in multiple CourseCatalog objects and removing the last reference to a CourseOffering 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 a CourseOffering to another CourseCatalog is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignCourseOfferingToCourseCatalog(Id courseOfferingId, Id courseCatalogId) Adds an existing CourseOffering to a CourseCatalog.
boolean	canAssignCourseOfferings() Tests if this user can alter course offering/course catalog mappings.
boolean	canAssignCourseOfferingToCourseCatalog(Id courseCatalogId) Tests if this user can alter course offering/course catalog mappings.
IdList	getAssignableCourseCatalogIds(Id courseCatalogId) Gets a list of course catalogs including and under the given course catalog node in which any course offering can be assigned.
IdList	getAssignableCourseCatalogIdsForCourseOffering(Id courseCatalogId, Id courseOfferingId) Gets a list of course catalogs including and under the given course catalog node in which a specific course offering can be assigned.
void	reassignCourseOfferingToCourseCatalog(Id courseOfferingId, Id fromCourseCatalogId, Id toCourseCatalogId) Moves a CourseOffering from one CourseCatalog to another.
void	unassignCourseOfferingFromCourseCatalog(Id courseOfferingId, Id courseCatalogId) Removes a CourseOffering 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

canAssignCourseOfferings

boolean canAssignCourseOfferings()

Tests if this user can alter course offering/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.

canAssignCourseOfferingToCourseCatalog

boolean canAssignCourseOfferingToCourseCatalog(Id courseCatalogId)

Tests if this user can alter course offering/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 course offering 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.

getAssignableCourseCatalogIdsForCourseOffering

IdList getAssignableCourseCatalogIdsForCourseOffering(Id courseCatalogId,
                                                    Id courseOfferingId)
                                                      throws OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

courseOfferingId - the Id of the CourseOffering

Returns:

list of assignable course catalog Ids

Throws:

NullArgumentException - courseCatalogId or courseOfferingId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignCourseOfferingToCourseCatalog

void assignCourseOfferingToCourseCatalog(Id courseOfferingId,
                                       Id courseCatalogId)
                                         throws AlreadyExistsException,
                                                NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Adds an existing CourseOffering to a CourseCatalog.

Parameters:

courseOfferingId - the Id of the CourseOffering

courseCatalogId - the Id of the CourseCatalog

Throws:

AlreadyExistsException - courseOfferingId is already assigned to courseCatalogId

NotFoundException - courseOfferingId or courseCatalogId not found

NullArgumentException - courseOfferingId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCourseOfferingFromCourseCatalog

void unassignCourseOfferingFromCourseCatalog(Id courseOfferingId,
                                           Id courseCatalogId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Removes a CourseOffering from a CourseCatalog.

Parameters:

courseOfferingId - the Id of the CourseOffering

courseCatalogId - the Id of the CourseCatalog

Throws:

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

NullArgumentException - courseOfferingId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignCourseOfferingToCourseCatalog

void reassignCourseOfferingToCourseCatalog(Id courseOfferingId,
                                         Id fromCourseCatalogId,
                                         Id toCourseCatalogId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Moves a CourseOffering from one CourseCatalog to another. Mappings to other CourseCatalogs are unaffected.

Parameters:

courseOfferingId - the Id of the CourseOffering

fromCourseCatalogId - the Id of the current CourseCatalog

toCourseCatalogId - the Id of the destination CourseCatalog

Throws:

NotFoundException - courseOfferingId, fromCourseCatalogId, or toCourseCatalogId not found or courseOfferingId not mapped to fromCourseCatalogId

NullArgumentException - courseOfferingId, fromCourseCatalogId, or toCourseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.