public interface LessonCourseCatalogAssignmentSession extends OsidSession
This session provides methods to re-assign Lessons
to
Course Catalogs.
A Lesson
may map to
multiple CourseCatalogs
and removing the last reference to
a Lesson
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 Lesson
to another
CourseCatalog
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignLessonToCourseCatalog(Id lessonId,
Id courseCatalogId)
Adds an existing
Lesson to an CourseCatalog. |
boolean |
canAssignLessons()
Tests if this user can alter lesson/course catalog mappings.
|
boolean |
canAssignLessonsToCourseCatalog(Id courseCatalogId)
Tests if this user can alter lesson/course catalog mappings.
|
IdList |
getAssignableCourseCatalogIds(Id courseCatalogId)
Gets a list of course catalogs including and under the given course
catalog node in which any lesson can be assigned.
|
IdList |
getAssignableCourseCatalogIdsForLesson(Id courseCatalogId,
Id lessonId)
Gets a list of course catalogs including and under the given course
catalog node in which a specific lesson can be assigned.
|
void |
reassignLessonToCourseCatalog(Id lessonId,
Id fromCourseCatalogId,
Id toCourseCatalogId)
Moves a
Lesson from one CourseCatalog to
another. |
void |
unassignLessonFromCourseCatalog(Id lessonId,
Id courseCatalogId)
Removes a
Lesson from an CourseCatalog. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignLessons()
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 canAssignLessonsToCourseCatalog(Id courseCatalogId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment 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 getAssignableCourseCatalogIdsForLesson(Id courseCatalogId, Id lessonId) throws OperationFailedException
courseCatalogId
- the Id
of the
CourseCatalog
lessonId
- the Id
of the Lesson
Ids
NullArgumentException
- courseCatalogId
or lessonId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignLessonToCourseCatalog(Id lessonId, Id courseCatalogId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Lesson
to an CourseCatalog.
lessonId
- the Id
of the Lesson
courseCatalogId
- the Id
of the
CourseCatalog
AlreadyExistsException
- lessonId
is
already assigned to courseCatalogId
NotFoundException
- lessonId
or
courseCatalogId
not foundNullArgumentException
- lessonId
or
courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignLessonFromCourseCatalog(Id lessonId, Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Lesson
from an CourseCatalog.
lessonId
- the Id
of the Lesson
courseCatalogId
- the Id
of the
CourseCatalog
NotFoundException
- lessonId
or
courseCatalogId
not found or lessonId
not assigned to courseCatalogId
NullArgumentException
- lessonId
or
courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignLessonToCourseCatalog(Id lessonId, Id fromCourseCatalogId, Id toCourseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Lesson
from one CourseCatalog
to
another. Mappings to other CourseCatalogs
are
unaffected.lessonId
- the Id
of the Lesson
fromCourseCatalogId
- the Id
of the current
CourseCatalog
toCourseCatalogId
- the Id
of the destination
CourseCatalog
NotFoundException
- lessonId,
fromCourseCatalogId,
or toCourseCatalogId
not found or lessonId
not mapped to
fromCourseCatalogId
NullArgumentException
- lessonId,
fromCourseCatalogId,
or toCourseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.