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