org.osid.course.program

Interface CredentialCourseCatalogAssignmentSession

All Superinterfaces:

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

public interface CredentialCourseCatalogAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignCredentialsToCourseCatalog(Id credentialId, Id courseCatalogId) Adds an existing Credential to a CourseCatalog.
boolean	canAssignCourses() Tests if this user can alter credential/course catalog mappings.
boolean	canAssignCredentialToCourseCatalog(Id courseCatalogId) Tests if this user can alter course/course catalog mappings.
IdList	getAssignableCourseCatalogIds(Id courseCatalogId) Gets a list of course catalogs including and under the given course catalog node in which any credential can be assigned.
IdList	getAssignableCourseCatalogIdsForCourse(Id courseCatalogId, Id credentialId) Gets a list of course catalogs including and under the given course catalog node in which a specific credential can be assigned.
void	reassignCredentialToCourseCatalog(Id credentialId, Id fromCourseCatalogId, Id toCourseCatalogId) Moves a Credential from one CourseCatalog to another.
void	unassignCredentialFromCourseCatalog(Id credentialId, Id courseCatalogId) Removes a Credential 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

canAssignCourses

boolean canAssignCourses()

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

canAssignCredentialToCourseCatalog

boolean canAssignCredentialToCourseCatalog(Id courseCatalogId)

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

getAssignableCourseCatalogIdsForCourse

IdList getAssignableCourseCatalogIdsForCourse(Id courseCatalogId,
                                            Id credentialId)
                                              throws OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

credentialId - the Id of the Credential

Returns:

list of assignable course catalog Ids

Throws:

NullArgumentException - courseCatalogId or credentialId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignCredentialsToCourseCatalog

void assignCredentialsToCourseCatalog(Id credentialId,
                                    Id courseCatalogId)
                                      throws AlreadyExistsException,
                                             NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Adds an existing Credential to a CourseCatalog.

Parameters:

credentialId - the Id of the Credential

courseCatalogId - the Id of the CourseCatalog

Throws:

AlreadyExistsException - credentialId isalready assigned to courseCatalogId

NotFoundException - credentialId or courseCatalogId not found

NullArgumentException - credentialId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCredentialFromCourseCatalog

void unassignCredentialFromCourseCatalog(Id credentialId,
                                       Id courseCatalogId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Removes a Credential from a CourseCatalog.

Parameters:

credentialId - the Id of the Credential

courseCatalogId - the Id of the CourseCatalog

Throws:

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

NullArgumentException - credentialId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignCredentialToCourseCatalog

void reassignCredentialToCourseCatalog(Id credentialId,
                                     Id fromCourseCatalogId,
                                     Id toCourseCatalogId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

credentialId - the Id of the Credential

fromCourseCatalogId - the Id of the current CourseCatalog

toCourseCatalogId - the Id of the destination CourseCatalog

Throws:

NotFoundException - credentialId, fromCourseCatalogId, or toCourseCatalogId not found or crededntialId, not mapped to fromCourseCatalogId

NullArgumentException - credentialId, fromCourseCatalogId, or toCourseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.