org.osid.course.program

Interface ProgramCourseCatalogAssignmentSession

All Superinterfaces:

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

public interface ProgramCourseCatalogAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignProgramToCourseCatalog(Id programId, Id courseCatalogId) Adds an existing Program to a CourseCatalog.
boolean	canAssignPrograms() Tests if this user can alter program/course catalog mappings.
boolean	canAssignProgramToCourseCatalog(Id courseCatalogId) Tests if this user can alter program/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 can be assigned.
IdList	getAssignableCourseCatalogIdsForProgram(Id courseCatalogId, Id programId) Gets a list of course catalogs including and under the given course catalog node in which a specific program can be assigned.
void	reassignProgramToCourseCatalog(Id programId, Id fromCourseCatalogId, Id toCourseCatalogId) Moves a Program from one CourseCatalog to another.
void	unassignProgramFromCourseCatalog(Id programId, Id courseCatalogId) Removes a Program 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

canAssignPrograms

boolean canAssignPrograms()

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

canAssignProgramToCourseCatalog

boolean canAssignProgramToCourseCatalog(Id courseCatalogId)

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

getAssignableCourseCatalogIdsForProgram

IdList getAssignableCourseCatalogIdsForProgram(Id courseCatalogId,
                                             Id programId)
                                               throws OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

programId - the Id of the Program

Returns:

list of assignable course catalog Ids

Throws:

NullArgumentException - courseCatalogId or programId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignProgramToCourseCatalog

void assignProgramToCourseCatalog(Id programId,
                                Id courseCatalogId)
                                  throws AlreadyExistsException,
                                         NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Adds an existing Program to a CourseCatalog.

Parameters:

programId - the Id of the Program

courseCatalogId - the Id of the CourseCatalog

Throws:

AlreadyExistsException - programId is already assigned to courseCatalogId

NotFoundException - programId or courseCatalogId not found

NullArgumentException - programId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProgramFromCourseCatalog

void unassignProgramFromCourseCatalog(Id programId,
                                    Id courseCatalogId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Removes a Program from a CourseCatalog.

Parameters:

programId - the Id of the Program

courseCatalogId - the Id of the CourseCatalog

Throws:

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

NullArgumentException - programId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignProgramToCourseCatalog

void reassignProgramToCourseCatalog(Id programId,
                                  Id fromCourseCatalogId,
                                  Id toCourseCatalogId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

programId - the Id of the Program

fromCourseCatalogId - the Id of the current CourseCatalog

toCourseCatalogId - the Id of the destination CourseCatalog

Throws:

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

NullArgumentException - programId, fromCourseCatalogId, or toCourseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.