| Interface | osid.offering.ResultCatalogueAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of an | ||
| Method | canAssignResults | ||
| Description |
Tests if this user can alter result/catalogue 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 | canAssignResultsToCatalogue | ||
| Description |
Tests if this user can alter result/catalogue 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 | catalogueId | the Id of the Catalogue |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | catalogueId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCatalogueIds | ||
| Description |
Gets a list of catalogues including and under the given catalogue node in which any result can be assigned. | ||
| Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
| Return | osid.id.IdList | list of assignable catalogue Ids | |
| Errors | NULL_ARGUMENT | catalogueId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCatalogueIdsForResult | ||
| Description |
Gets a list of catalogues including and under the given catalogue node in which a specific result can be assigned. | ||
| Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
osid.id.Id | resultId | the Id of the Result | |
| Return | osid.id.IdList | list of assignable catalogue Ids | |
| Errors | NULL_ARGUMENT | catalogueId or resultId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignResultToCatalogue | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | resultId | the Id of the Result |
osid.id.Id | catalogueId | the Id of the Catalogue | |
| Errors | ALREADY_EXISTS | resultId already assigned to catalogueId | |
| NOT_FOUND | resultId or catalogueId not found | ||
| NULL_ARGUMENT | resultId or catalogueId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignResultFromCatalogue | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | resultId | the Id of the Result |
osid.id.Id | catalogueId | the Id of the Catalogue | |
| Errors | NOT_FOUND | resultId or catalogueId not found or
resultId not mapped to catalogueId | |
| NULL_ARGUMENT | resultId or catalogueId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |