OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainerRuleApplicationSession
Implementsosid.OsidSession
Description

This session provides methods to apply OfferingConstrainers to CanonicalUnits to constrain the offerings for a canonical unit. A CanonicalUnit with multiple OfferingConstrainers means any positive rule evaluation across the result in an effective CanonicalUnit.

MethodgetCatalogueId
Description

Gets the Catalogue Id associated with this session.

Returnosid.id.Idthe Catalogue Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCatalogue
Description

Gets the Catalogue associated with this session.

Returnosid.offering.Cataloguethe catalogue
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignOfferingConstrainers
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignOfferingConstrainerToCanonicalUnit
Description

Adds an existing OfferingConstrainer to a CanonicalUnit.

Parametersosid.id.IdofferingConstrainerIdthe Id of the OfferingConstrainer
osid.id.IdcanonicalUnitIdthe Id of the CanonicalUnit
ErrorsALREADY_EXISTS offeringConstrainerId already applied to canonicalUnitId
NOT_FOUND offeringConstrainerId or canonicalUnitId not found
NULL_ARGUMENT offeringConstrainerId or canonicalUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignOfferingConstrainerFromCanonicalUnit
Description

Removes an OfferingConstrainer from a CanonicalUnit.

Parametersosid.id.IdofferingConstrainerIdthe Id of the OfferingConstrainer
osid.id.IdcanonicalUnitIdthe Id of the CanonicalUnit
ErrorsNOT_FOUND offeringConstrainerId or canonicalUnitId not found or offeringConstrainerId already applied to canonicalUnitId
NULL_ARGUMENT offeringConstrainerId or canonicalUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceOfferingConstrainers
Description

Tests if this user can order OfferingConstrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if OfferingConstrainer ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveOfferingConstrainerAhead
Description

Reorders offering constrainers for a canonical unit by moving the specified offering constrainer in front of a reference offering constrainer.

Parametersosid.id.IdofferingConstrainerIdthe Id of an OfferingConstrainer
osid.id.IdcanonicalUnitIdthe Id of a CanonicalUnit
osid.id.IdreferenceIdthe reference offering constrainer Id
ErrorsNOT_FOUND offeringConstrainerId, canonicalUnitId, or referenceId not found or, offeringConstrainerId or referenceId not related to canonicalUnitId
NULL_ARGUMENT offeringConstrainerId, canonicalUnitId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveOfferingConstrainerBehind
Description

Reorders offering constrainers for a canonical unit by moving the specified offering constrainer behind a reference offering constrainer.

Parametersosid.id.IdofferingConstrainerIdthe Id of an OfferingConstrainer
osid.id.IdcanonicalUnitIdthe Id of a CanonicalUnit
osid.id.IdreferenceIdthe reference offering constrainer Id
ErrorsNOT_FOUND offeringConstrainerId, canonicalUnitId, or referenceId not found or, offeringConstrainerId or referenceId not related to canonicalUnitId
NULL_ARGUMENT offeringConstrainerId, canonicalUnitId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderOfferingConstrainers
Description

Reorders a set of offering constrainers for a canonical unit.

Parametersosid.id.Id[]offeringConstrainerIdsthe Ids for a set of OfferingConstrainers
osid.id.IdcanonicalUnitIdthe Id of a CanonicalUnit
ErrorsNOT_FOUND canonicalUnitId not found or, an offeringConstrainerId not related to canonicalUnitId
NULL_ARGUMENT offeringConstrainerIds or canonicalUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.