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
).
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignCredentialEntries()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer assignment
operations to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignCredentialEntryToCourseCatalog(Id courseCatalogId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.courseCatalogId
- the Id
of the
CourseCatalog
false
if mapping is not authorized, true
otherwiseNullArgumentException
- courseCatalogId
is null
mandatory
- This method must be implemented. IdList getAssignableCourseCatalogIds(Id courseCatalogId) throws OperationFailedException
courseCatalogId
- the Id
of the
CourseCatalog
Ids
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableCourseCatalogIdsForCredentialEntry(Id courseCatalogId, Id credentialEntryId) throws OperationFailedException
courseCatalogId
- the Id
of the
CourseCatalog
credentialEntryId
- the Id
of the
CredentialEntry
Ids
NullArgumentException
- courseCatalogId
or credentialEntryId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignCredentialEntryToCourseCatalog(Id credentialEntryId, Id courseCatalogId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
CredentialEntry
to a
CourseCatalog.
credentialEntryId
- the Id
of the
CredentialEntry
courseCatalogId
- the Id
of the
CourseCatalog
AlreadyExistsException
- credentialEntryId
is already assigned to courseCatalogId
NotFoundException
- credentialEntryId
or
courseCatalogId
not foundNullArgumentException
- credentialEntryId
or courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCredentialEntryFromCourseCatalog(Id credentialEntryId, Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CredentialEntry
from a CourseCatalog.
credentialEntryId
- the Id
of the
CredentialEntry
courseCatalogId
- the Id
of the
CourseCatalog
NotFoundException
- credentialEntryId
or
courseCatalogId
not found or
credentialEntryId
not assigned to
courseCatalogId
NullArgumentException
- credentialEntryId
or courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignCredentialEntryToCourseCatalog(Id credentialEntryId, Id fromCourseCatalogId, Id toCourseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CredentialEntry
from one CourseCatalog
to another. Mappings to other CourseCatalogs
are unaffected.credentialEntryId
- the Id
of the
CredentialEntry
fromCourseCatalogId
- the Id
of the current
CourseCatalog
toCourseCatalogId
- the Id
of the destination
CourseCatalog
NotFoundException
- credentialEntryId,
fromCourseCatalogId,
or toCourseCatalogId
not found or credentialEntryId
not
mapped to fromCourseCatalogId
NullArgumentException
- credentialEntryId,
fromCourseCatalogId,
or toCourseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.