public interface TermCourseCatalogAssignmentSession extends OsidSession
This session provides methods to re-assign Terms
to
CourseCatalog
objects A Term
may appear in
multiple CourseCatalog
objects and removing the last
reference to a Term
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 Term
to another
CourseCatalog
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignTermToCatalog(Id termId,
Id courseCatalogId)
Adds an existing
Term to a CourseCatalog. |
boolean |
canAssignTerms()
Tests if this user can alter term/course catalog mappings.
|
boolean |
canAssignTermsToCourseCatalog(Id courseCatalogId)
Tests if this user can alter term/course catalog mappings.
|
IdList |
getAssignableCourseCatalogIds(Id courseCatalogId)
Gets a list of course catalogs including and under the given course
catalog node in which any term can be assigned.
|
IdList |
getAssignableCourseCatalogIdsForTerm(Id courseCatalogId,
Id termId)
Gets a list of course catalogs including and under the given course
catalog node in which a specific term can be assigned.
|
void |
unassignTermFromCatalog(Id termId,
Id courseCatalogId)
Removes a
Term from a CourseCatalog. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignTerms()
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 canAssignTermsToCourseCatalog(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 getAssignableCourseCatalogIdsForTerm(Id courseCatalogId, Id termId) throws OperationFailedException
courseCatalogId
- the Id
of the
CourseCatalog
termId
- the Id
of the Term
Ids
NullArgumentException
- courseCatalogId
or termId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignTermToCatalog(Id termId, Id courseCatalogId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Term
to a CourseCatalog.
termId
- the Id
of the Term
courseCatalogId
- the Id
of the
CourseCatalog
AlreadyExistsException
- termId
is
already assigned to courseCatalogId
NotFoundException
- termId
or
courseCatalogId
not foundNullArgumentException
- termId
or
courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignTermFromCatalog(Id termId, Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Term
from a CourseCatalog.
termId
- the Id
of the Term
courseCatalogId
- the Id
of the
CourseCatalog
NotFoundException
- termId
or
courseCatalogId
not found or termId
not
assigned to courseCatalogId
NullArgumentException
- termId
or
courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.