Interface OfferingConstrainer

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidConstrainer, OsidObject, OsidRule
public interface OfferingConstrainer extends OsidConstrainer

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

  • Method Details

    • canOverrideDescription

      boolean canOverrideDescription()
      Tests if the description can be overridden at offering.
      Returns:
      true if the description can be overridden, false if constrained
      Compliance:
      mandatory - This method must be implemented.

    • canOverrideTitle

      boolean canOverrideTitle()
      Tests if the title can be overridden at offering.
      Returns:
      true if the title can be overridden, false if constrained
      Compliance:
      mandatory - This method must be implemented.

    • canOverrideCode

      boolean canOverrideCode()
      Tests if the code can be overridden at offering.
      Returns:
      true if the code can be overridden, false if constrained
      Compliance:
      mandatory - This method must be implemented.

    • canOverrideTimePeriods

      boolean canOverrideTimePeriods()
      Tests if the offerings can be made outside the specified time period cycles.
      Returns:
      true if the time period cycles can be overridden, false if constrained
      Compliance:
      mandatory - This method must be implemented.

    • canConstrainTimePeriods

      boolean canConstrainTimePeriods()
      Tests if offerings in all specified time periods are optional.
      Returns:
      true if the time period cycles can be optional, false if constrained
      Compliance:
      mandatory - This method must be implemented.

    • canOverrideResultOptions

      boolean canOverrideResultOptions()
      Tests if the result options can be overridden at offering.
      Returns:
      true if the result options can be overridden, false if constrained
      Compliance:
      mandatory - This method must be implemented.

    • canConstrainResultOptions

      boolean canConstrainResultOptions()
      Tests if the offering result options can be a subset of the canonical set.
      Returns:
      true if the result options can be a subset, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canOverrideSponsors

      boolean canOverrideSponsors()
      Tests if the sponsors can be overridden at offering.
      Returns:
      true if the sponsors can be overridden, false if constrained
      Compliance:
      mandatory - This method must be implemented.

    • canConstrainSponsors

      boolean canConstrainSponsors()
      Tests if the offering sponsors can be a subset of the canonical set.
      Returns:
      true if the sponsors can be a subset, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerRecord

      OfferingConstrainerRecord getOfferingConstrainerRecord(Type offeringConstrainerRecordType) throws OperationFailedException
      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 .
      Parameters:
      offeringConstrainerRecordType - the type of offering constrainer record to retrieve
      Returns:
      the offering constrainer record
      Throws:
      NullArgumentException - offeringConstrainerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(offeringConstrainerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.