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