org.osid.course.program

Interface ProgramOfferingCourseCatalogAssignmentSession

All Superinterfaces:

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

public interface ProgramOfferingCourseCatalogAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignProgramOfferingToCourseCatalog(Id programOfferingId, Id courseCatalogId) Adds an existing ProgramOffering to a CourseCatalog.
boolean	canAssignProgramOfferings() Tests if this user can alter program offering/course catalog mappings.
boolean	canAssignProgramOfferingToCourseCatalog(Id courseCatalogId) Tests if this user can alter program 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 program offering can be assigned.
IdList	getAssignableCourseCtalogIdsForProgramOffering(Id courseCatalogId, Id programOfferingId) Gets a list of course catalogs including and under the given course catalog node in which a specific program offering can be assigned.
void	reassignProgramOfferingToCourseCatalog(Id programOfferingId, Id fromCourseCatalogId, Id toCourseCatalogId) Moves a ProgramOffering from one CourseCatalog to another.
void	unassignProgramOfferingFromCourseCatalog(Id programOfferingId, Id courseCatalogId) Removes a ProgramOffering 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

canAssignProgramOfferings

boolean canAssignProgramOfferings()

Tests if this user can alter program 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.

canAssignProgramOfferingToCourseCatalog

boolean canAssignProgramOfferingToCourseCatalog(Id courseCatalogId)

Tests if this user can alter program 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 program 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.

getAssignableCourseCtalogIdsForProgramOffering

IdList getAssignableCourseCtalogIdsForProgramOffering(Id courseCatalogId,
                                                    Id programOfferingId)
                                                      throws OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

programOfferingId - the Id of the ProgramOffering

Returns:

list of assignable course catalog Ids

Throws:

NullArgumentException - courseCatalogId or programOfferingId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignProgramOfferingToCourseCatalog

void assignProgramOfferingToCourseCatalog(Id programOfferingId,
                                        Id courseCatalogId)
                                          throws AlreadyExistsException,
                                                 NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Adds an existing ProgramOffering to a CourseCatalog.

Parameters:

programOfferingId - the Id of the ProgramOffering

courseCatalogId - the Id of the CourseCatalog

Throws:

AlreadyExistsException - programOfferingId is already assigned to courseCatalogId

NotFoundException - programOfferingId or courseCatalogId not found

NullArgumentException - programOfferingId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProgramOfferingFromCourseCatalog

void unassignProgramOfferingFromCourseCatalog(Id programOfferingId,
                                            Id courseCatalogId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Removes a ProgramOffering from a CourseCatalog.

Parameters:

programOfferingId - the Id of the ProgramOffering

courseCatalogId - the Id of the CourseCatalog

Throws:

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

NullArgumentException - programOfferingId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignProgramOfferingToCourseCatalog

void reassignProgramOfferingToCourseCatalog(Id programOfferingId,
                                          Id fromCourseCatalogId,
                                          Id toCourseCatalogId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

programOfferingId - the Id of the ProgramOffering

fromCourseCatalogId - the Id of the current CourseCatalog

toCourseCatalogId - the Id of the destination CourseCatalog

Throws:

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

NullArgumentException - programOfferingId, fromCourseCatalogId, or toCourseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.