OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainer
Implementsosid.OsidConstrainer
Description

An OfferingConstrainer describes the rules for constraining the bids in a canonical unit.

MethodcanOverrideDescription
Description

Tests if the description can be overridden at offering.

Returnboolean true if the description can be overridden, false if constrained
CompliancemandatoryThis method must be implemented.
MethodcanOverrideTitle
Description

Tests if the title can be overridden at offering.

Returnboolean true if the title can be overridden, false if constrained
CompliancemandatoryThis method must be implemented.
MethodcanOverrideCode
Description

Tests if the code can be overridden at offering.

Returnboolean true if the code can be overridden, false if constrained
CompliancemandatoryThis method must be implemented.
MethodcanOverrideTimePeriods
Description

Tests if the offerings can be made outside the specified time period cycles.

Returnboolean true if the time period cycles can be overridden, false if constrained
CompliancemandatoryThis method must be implemented.
MethodcanConstrainTimePeriods
Description

Tests if offerings in all specified time periods are optional.

Returnboolean true if the time period cycles can be optional, false if constrained
CompliancemandatoryThis method must be implemented.
MethodcanOverrideResultOptions
Description

Tests if the result options can be overridden at offering.

Returnboolean true if the result options can be overridden, false if constrained
CompliancemandatoryThis method must be implemented.
MethodcanConstrainResultOptions
Description

Tests if the offering result options can be a subset of the canonical set.

Returnboolean true if the result options can be a subset, false otherwise
CompliancemandatoryThis method must be implemented.
MethodcanOverrideSponsors
Description

Tests if the sponsors can be overridden at offering.

Returnboolean true if the sponsors can be overridden, false if constrained
CompliancemandatoryThis method must be implemented.
MethodcanConstrainSponsors
Description

Tests if the offering sponsors can be a subset of the canonical set.

Returnboolean true if the sponsors can be a subset, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerRecord
Description

Gets the offering constrainer record corresponding to the given OfferingConstrainer record Type. This method is used to retrieve an object implementing the requested record. The offeringConstrainerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(offeringConstrainerRecordType) is true .

Parametersosid.type.TypeofferingConstrainerRecordTypethe type of offering constrainer record to retrieve
Returnosid.offering.rules.records.OfferingConstrainerRecordthe offering constrainer record
ErrorsNULL_ARGUMENT offeringConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offeringConstrainerRecordType) is false
CompliancemandatoryThis method must be implemented.