public interface OfferingConstrainer extends OsidConstrainer
An OfferingConstrainer
describes the rules for
constraining the bids in a canonical unit.
Modifier and Type | Method and Description |
---|---|
boolean |
canConstrainResultOptions()
Tests if the offering result options can be a subset of the canonical
set.
|
boolean |
canConstrainSponsors()
Tests if the offering sponsors can be a subset of the canonical set.
|
boolean |
canConstrainTimePeriods()
Tests if offerings in all specified time periods are optional.
|
boolean |
canOverrideCode()
Tests if the code can be overridden at offering.
|
boolean |
canOverrideDescription()
Tests if the description can be overridden at offering.
|
boolean |
canOverrideResultOptions()
Tests if the result options can be overridden at offering.
|
boolean |
canOverrideSponsors()
Tests if the sponsors can be overridden at offering.
|
boolean |
canOverrideTimePeriods()
Tests if the offerings can be made outside the specified time period
cycles.
|
boolean |
canOverrideTitle()
Tests if the title can be overridden at offering.
|
OfferingConstrainerRecord |
getOfferingConstrainerRecord(Type offeringConstrainerRecordType)
Gets the offering constrainer record corresponding to the given
OfferingConstrainer record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
boolean canOverrideDescription()
true
if the description can be overridden,
false
if constrainedmandatory
- This method must be implemented. boolean canOverrideTitle()
true
if the title can be overridden,
false
if constrainedmandatory
- This method must be implemented. boolean canOverrideCode()
true
if the code can be overridden,
false
if constrainedmandatory
- This method must be implemented. boolean canOverrideTimePeriods()
true
if the time period cycles can be
overridden, false
if constrainedmandatory
- This method must be implemented. boolean canConstrainTimePeriods()
true
if the time period cycles can be optional,
false
if constrainedmandatory
- This method must be implemented. boolean canOverrideResultOptions()
true
if the result options can be overridden,
false
if constrainedmandatory
- This method must be implemented. boolean canConstrainResultOptions()
true
if the result options can be a subset,
false
otherwisemandatory
- This method must be implemented. boolean canOverrideSponsors()
true
if the sponsors can be overridden,
false
if constrainedmandatory
- This method must be implemented. boolean canConstrainSponsors()
true
if the sponsors can be a subset,
false
otherwisemandatory
- This method must be implemented. OfferingConstrainerRecord getOfferingConstrainerRecord(Type offeringConstrainerRecordType) throws OperationFailedException
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
.offeringConstrainerRecordType
- the type of offering constrainer
record to retrieveNullArgumentException
-
offeringConstrainerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offeringConstrainerRecordType)
is
false
mandatory
- This method must be implemented.