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