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