Interface | osid.course.chronicle.CredentialEntryCourseCatalogAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignCredentialEntries | ||
Description |
Tests if this user can alter credential entry/course
catalog mappings. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known mapping methods in this session will result in
a | ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignCredentialEntryToCourseCatalog | ||
Description |
Tests if this user can alter credential entry/course
catalog mappings. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known mapping methods in this session will result in
a | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | courseCatalogId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCourseCatalogIds | ||
Description |
Gets a list of course catalogs including and under the given course catalog node in which any credential entry can be assigned. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.id.IdList | list of assignable course catalog Ids | |
Errors | NULL_ARGUMENT | courseCatalogId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCourseCatalogIdsForCredentialEntry | ||
Description |
Gets a list of course catalogs including and under the given course catalog node in which a specific credential entry can be assigned. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
osid.id.Id | credentialEntryId | the Id of the CredentialEntry | |
Return | osid.id.IdList | list of assignable course catalog Ids | |
Errors | NULL_ARGUMENT | courseCatalogId or credentialEntryId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCredentialEntryToCourseCatalog | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | credentialEntryId | the Id of the CredentialEntry |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Errors | ALREADY_EXISTS | credentialEntryId is already assigned to
courseCatalogId | |
NOT_FOUND | credentialEntryId or courseCatalogId not
found | ||
NULL_ARGUMENT | credentialEntryId or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCredentialEntryFromCourseCatalog | ||
Description |
Removes a | ||
Parameters | osid.id.Id | credentialEntryId | the Id of the CredentialEntry |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Errors | NOT_FOUND | credentialEntryId or courseCatalogId not
found or credentialEntryId not assigned to
courseCatalogId | |
NULL_ARGUMENT | credentialEntryId or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignCredentialEntryToCourseCatalog | ||
Description |
Moves a | ||
Parameters | osid.id.Id | credentialEntryId | the Id of the CredentialEntry |
osid.id.Id | fromCourseCatalogId | the Id of the current CourseCatalog | |
osid.id.Id | toCourseCatalogId | the Id of the destination CourseCatalog | |
Errors | NOT_FOUND | credentialEntryId, fromCourseCatalogId, or
toCourseCatalogId not found or credentialEntryId not
mapped to fromCourseCatalogId | |
NULL_ARGUMENT | credentialEntryId, fromCourseCatalogId, or
toCourseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |