| Interface | osid.offering.OfferingCatalogueAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.offering.OfferingManager | ||
osid.offering.OfferingProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of an | ||
| Method | canAssignOfferings | ||
| Description |
Tests if this user can alter offering/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 | canAssignOfferingsToCatalogue | ||
| Description |
Tests if this user can alter offering/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 offering 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 | getAssignableCatalogueIdsForOffering | ||
| Description |
Gets a list of catalogues including and under the given catalogue node in which a specific offering can be assigned. | ||
| Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
osid.id.Id | offeringId | the Id of the Offering | |
| Return | osid.id.IdList | list of assignable catalogue Ids | |
| Errors | NULL_ARGUMENT | catalogueId or offeringId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignOfferingToCatalogue | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | offeringId | the Id of the Offering |
osid.id.Id | catalogueId | the Id of the Catalogue | |
| Errors | ALREADY_EXISTS | offeringId already assigned to catalogueId | |
| NOT_FOUND | offeringId or catalogueId not found | ||
| NULL_ARGUMENT | offeringId or catalogueId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignOfferingFromCatalogue | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | offeringId | the Id of the Offering |
osid.id.Id | catalogueId | the Id of the Catalogue | |
| Errors | NOT_FOUND | offeringId or catalogueId not found or
offeringId not mapped to catalogueId | |
| NULL_ARGUMENT | offeringId or catalogueId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignOfferingToCatalogue | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | offeringId | the Id of the Offering |
osid.id.Id | fromCatalogueId | the Id of the current Catalogue | |
osid.id.Id | toCatalogueId | the Id of the destination Catalogue | |
| Errors | ALREADY_EXISTS | offeringId already assigned to toCatalogueId | |
| NOT_FOUND | offeringId, fromCatalogueId , or toCatalogueId
not found or offeringId not mapped to
fromCatalogueId | ||
| NULL_ARGUMENT | offeringId, fromCatalogueId , or toCatalogueId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |