Interface | osid.offering.rules.OfferingConstrainerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getCatalogueId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Catalogue Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogue | ||
Description |
Gets the | ||
Return | osid.offering.Catalogue | the catalogue | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignOfferingConstrainers | ||
Description |
Tests if this user can alter offering
constrainer/canonical unit 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 | assignOfferingConstrainerToCanonicalUnit | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | offeringConstrainerId | the Id of the OfferingConstrainer |
osid.id.Id | canonicalUnitId | the Id of the CanonicalUnit | |
Errors | ALREADY_EXISTS | offeringConstrainerId already applied to
canonicalUnitId | |
NOT_FOUND | offeringConstrainerId or canonicalUnitId not
found | ||
NULL_ARGUMENT | offeringConstrainerId or canonicalUnitId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignOfferingConstrainerFromCanonicalUnit | ||
Description |
Removes an | ||
Parameters | osid.id.Id | offeringConstrainerId | the Id of the OfferingConstrainer |
osid.id.Id | canonicalUnitId | the Id of the CanonicalUnit | |
Errors | NOT_FOUND | offeringConstrainerId or canonicalUnitId not
found or offeringConstrainerId already applied to
canonicalUnitId | |
NULL_ARGUMENT | offeringConstrainerId or canonicalUnitId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceOfferingConstrainers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if OfferingConstrainer ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveOfferingConstrainerAhead | ||
Description |
Reorders offering constrainers for a canonical unit by moving the specified offering constrainer in front of a reference offering constrainer. | ||
Parameters | osid.id.Id | offeringConstrainerId | the Id of an OfferingConstrainer |
osid.id.Id | canonicalUnitId | the Id of a CanonicalUnit | |
osid.id.Id | referenceId | the reference offering constrainer Id | |
Errors | NOT_FOUND | offeringConstrainerId, canonicalUnitId, or
referenceId not found or, offeringConstrainerId or
referenceId not related to canonicalUnitId | |
NULL_ARGUMENT | offeringConstrainerId, canonicalUnitId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveOfferingConstrainerBehind | ||
Description |
Reorders offering constrainers for a canonical unit by moving the specified offering constrainer behind a reference offering constrainer. | ||
Parameters | osid.id.Id | offeringConstrainerId | the Id of an OfferingConstrainer |
osid.id.Id | canonicalUnitId | the Id of a CanonicalUnit | |
osid.id.Id | referenceId | the reference offering constrainer Id | |
Errors | NOT_FOUND | offeringConstrainerId, canonicalUnitId, or
referenceId not found or, offeringConstrainerId or
referenceId not related to canonicalUnitId | |
NULL_ARGUMENT | offeringConstrainerId, canonicalUnitId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderOfferingConstrainers | ||
Description |
Reorders a set of offering constrainers for a canonical unit. | ||
Parameters | osid.id.Id[] | offeringConstrainerIds | the Ids for a set of OfferingConstrainers |
osid.id.Id | canonicalUnitId | the Id of a CanonicalUnit | |
Errors | NOT_FOUND | canonicalUnitId not found or, an
offeringConstrainerId not related to canonicalUnitId | |
NULL_ARGUMENT | offeringConstrainerIds or canonicalUnitId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |