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