Interface | osid.offering.CanonicalUnitCatalogueAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignCanonicalUnits | ||
Description |
Tests if this user can alter canonical unit/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 | canAssignCanonicalUnitsToCatalogue | ||
Description |
Tests if this user can alter canonical unit/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 canonical unit 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 | getAssignableCatalogueIdsForCanonicalUnit | ||
Description |
Gets a list of catalogues including and under the given catalogue node in which a specific canonical unit can be assigned. | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
osid.id.Id | canonicalUnitId | the Id of the CanonicalUnit | |
Return | osid.id.IdList | list of assignable catalogue Ids | |
Errors | NULL_ARGUMENT | catalogueId or canonicalUnitId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCanonicalUnitToCatalogue | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | canonicalUnitId | the Id of the CanonicalUnit |
osid.id.Id | catalogueId | the Id of the Catalogue | |
Errors | ALREADY_EXISTS | canonicalUnitId already assigned to catalogueId
| |
NOT_FOUND | canonicalUnitId or catalogueId not found | ||
NULL_ARGUMENT | canonicalUnitId or catalogueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCanonicalUnitFromCatalogue | ||
Description |
Removes a | ||
Parameters | osid.id.Id | canonicalUnitId | the Id of the CanonicalUnit |
osid.id.Id | catalogueId | the Id of the Catalogue | |
Errors | NOT_FOUND | canonicalUnitId or catalogueId not found or
canonicalUnitId not mapped to catalogueId | |
NULL_ARGUMENT | canonicalUnitId or catalogueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |