org.osid.course.chronicle

Interface CredentialEntryCourseCatalogAssignmentSession

All Superinterfaces:

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

public interface CredentialEntryCourseCatalogAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignCredentialEntryToCourseCatalog(Id credentialEntryId, Id courseCatalogId) Adds an existing CredentialEntry to a CourseCatalog.
boolean	canAssignCredentialEntries() Tests if this user can alter credential entry/course catalog mappings.
boolean	canAssignCredentialEntryToCourseCatalog(Id courseCatalogId) Tests if this user can alter credential entry/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 entry can be assigned.
IdList	getAssignableCourseCatalogIdsForCredentialEntry(Id courseCatalogId, Id credentialEntryId) Gets a list of course catalogs including and under the given course catalog node in which a specific credential entry can be assigned.
void	reassignCredentialEntryToCourseCatalog(Id credentialEntryId, Id fromCourseCatalogId, Id toCourseCatalogId) Moves a CredentialEntry from one CourseCatalog to another.
void	unassignCredentialEntryFromCourseCatalog(Id credentialEntryId, Id courseCatalogId) Removes a CredentialEntry 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

canAssignCredentialEntries

boolean canAssignCredentialEntries()

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

canAssignCredentialEntryToCourseCatalog

boolean canAssignCredentialEntryToCourseCatalog(Id courseCatalogId)

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

getAssignableCourseCatalogIdsForCredentialEntry

IdList getAssignableCourseCatalogIdsForCredentialEntry(Id courseCatalogId,
                                                     Id credentialEntryId)
                                                       throws OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

credentialEntryId - the Id of the CredentialEntry

Returns:

list of assignable course catalog Ids

Throws:

NullArgumentException - courseCatalogId or credentialEntryId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignCredentialEntryToCourseCatalog

void assignCredentialEntryToCourseCatalog(Id credentialEntryId,
                                        Id courseCatalogId)
                                          throws AlreadyExistsException,
                                                 NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Adds an existing CredentialEntry to a CourseCatalog.

Parameters:

credentialEntryId - the Id of the CredentialEntry

courseCatalogId - the Id of the CourseCatalog

Throws:

AlreadyExistsException - credentialEntryId is already assigned to courseCatalogId

NotFoundException - credentialEntryId or courseCatalogId not found

NullArgumentException - credentialEntryId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCredentialEntryFromCourseCatalog

void unassignCredentialEntryFromCourseCatalog(Id credentialEntryId,
                                            Id courseCatalogId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Removes a CredentialEntry from a CourseCatalog.

Parameters:

credentialEntryId - the Id of the CredentialEntry

courseCatalogId - the Id of the CourseCatalog

Throws:

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

NullArgumentException - credentialEntryId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignCredentialEntryToCourseCatalog

void reassignCredentialEntryToCourseCatalog(Id credentialEntryId,
                                          Id fromCourseCatalogId,
                                          Id toCourseCatalogId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

credentialEntryId - the Id of the CredentialEntry

fromCourseCatalogId - the Id of the current CourseCatalog

toCourseCatalogId - the Id of the destination CourseCatalog

Throws:

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

NullArgumentException - credentialEntryId, fromCourseCatalogId, or toCourseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.