public interface AssessmentEntryCourseCatalogAssignmentSession extends OsidSession
This session provides methods to re-assign AssessmentEntries
to CourseCatalogs.
An AssessmentEntry
may appear in multiple CourseCatalogs
and removing
the last reference to an AssessmentEntry
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 an AssessmentEntry
to another
CourseCatalog
is not a copy operation (eg: does not change
its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignAssessmentEntryToCourseCatalog(Id assessmentEntryId,
Id courseCatalogId)
Adds an existing
AssessmentEntry to a
CourseCatalog. |
boolean |
canAssignAssessmentEntries()
Tests if this user can alter assessment entry/course catalog mappings.
|
boolean |
canAssignAssessmentEntryToCourseCatalog(Id courseCatalogId)
Tests if this user can alter assessment 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 assessment entry can be assigned.
|
IdList |
getAssignableCourseCatalogIdsForAssessmentEntry(Id courseCatalogId,
Id assessmentEntryId)
Gets a list of course catalogs including and under the given course
catalog node in which a specific assessment entry can be assigned.
|
void |
reassignAssessmentEntryToCourseCatalog(Id assessmentEntryId,
Id fromCourseCatalogId,
Id toCourseCatalogId)
Moves an
AssessmentEntry from one CourseCatalog
to another. |
void |
unassignAssessmentEntryFromCourseCatalog(Id assessmentEntryId,
Id courseCatalogId)
Removes an
AssessmentEntry from a CourseCatalog. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAssessmentEntries()
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 canAssignAssessmentEntryToCourseCatalog(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 getAssignableCourseCatalogIdsForAssessmentEntry(Id courseCatalogId, Id assessmentEntryId) throws OperationFailedException
courseCatalogId
- the Id
of the
CourseCatalog
assessmentEntryId
- the Id
of the
AssessmentEntry
Ids
NullArgumentException
- courseCatalogId
or assessmentEntryId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAssessmentEntryToCourseCatalog(Id assessmentEntryId, Id courseCatalogId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentEntry
to a
CourseCatalog.
assessmentEntryId
- the Id
of the
AssessmentEntry
courseCatalogId
- the Id
of the
CourseCatalog
AlreadyExistsException
- assessmentEntryId
is already assigned to courseCatalogId
NotFoundException
- assessmentEntryId
or
courseCatalogId
not foundNullArgumentException
- assessmentEntryId
or courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAssessmentEntryFromCourseCatalog(Id assessmentEntryId, Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentEntry
from a CourseCatalog.
assessmentEntryId
- the Id
of the
AssessmentEntry
courseCatalogId
- the Id
of the
CourseCatalog
NotFoundException
- assessmentEntryId
or
courseCatalogId
not found or
assessmentEntryId
not assigned to
courseCatalogId
NullArgumentException
- assessmentEntryId
or courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignAssessmentEntryToCourseCatalog(Id assessmentEntryId, Id fromCourseCatalogId, Id toCourseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentEntry
from one CourseCatalog
to another. Mappings to other CourseCatalogs
are unaffected.assessmentEntryId
- the Id
of the
AssessmentEntry
fromCourseCatalogId
- the Id
of the current
CourseCatalog
toCourseCatalogId
- the Id
of the destination
CourseCatalog
NotFoundException
- assessmentEntryId,
fromCourseCatalogId,
or toCourseCatalogId
not found or assessmentEntryId
not
mapped to fromCourseCatalogId
NullArgumentException
- assessmentEntryId,
fromCourseCatalogId,
or toCourseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.