| Interface | osid.offering.rules.OfferingConstrainerCatalogueAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of an | ||
| Method | canAssignOfferingConstrainers | ||
| Description |
Tests if this user can alter offering
constrainer/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 | canAssignOfferingConstrainersToCatalogue | ||
| Description |
Tests if this user can alter offering
constrainer/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 constrainer 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 | getAssignableCatalogueIdsForOfferingConstrainer | ||
| Description |
Gets a list of catalogues including and under the given catalogue node in which a specific offering constrainer can be assigned. | ||
| Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
osid.id.Id | offeringConstrainerId | the Id of the OfferingConstrainer | |
| Return | osid.id.IdList | list of assignable catalogue Ids | |
| Errors | NULL_ARGUMENT | catalogueId or offeringConstrainerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignOfferingConstrainerToCatalogue | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | offeringConstrainerId | the Id of the OfferingConstrainer |
osid.id.Id | catalogueId | the Id of the Catalogue | |
| Errors | ALREADY_EXISTS | offeringConstrainerId already assigned to catalogueId
| |
| NOT_FOUND | offeringConstrainerId or catalogueId not
found | ||
| NULL_ARGUMENT | offeringConstrainerId or catalogueId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignOfferingConstrainerFromCatalogue | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | offeringConstrainerId | the Id of the OfferingConstrainer |
osid.id.Id | catalogueId | the Id of the Catalogue | |
| Errors | NOT_FOUND | offeringConstrainerId or catalogueId not
found or offeringConstrainerId already assigned to
catalogueId | |
| NULL_ARGUMENT | offeringConstrainerId or catalogueId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignOfferingConstrainerToCatalogue | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | offeringConstrainerId | the Id of the OfferingConstrainer |
osid.id.Id | fromCatalogueId | the Id of the current Catalogue | |
osid.id.Id | toCatalogueId | the Id of the destination Catalogue | |
| Errors | NOT_FOUND | offeringConstraienrId, fromCatalogueId, or
toCatalogueId not found or offeringConstrainerId, not
mapped to fromCatalogueId | |
| NULL_ARGUMENT | offeringConstrainerId, fromCatalogueId, or
toCatalogueId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |