Interface PriceEnablerForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidEnablerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidTemporalForm, Suppliable
public interface PriceEnablerForm extends OsidEnablerForm

This is the form for creating and updating PriceEnablers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PriceEnablerAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Like all OsidForms, PriceEnablerForm is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getMinQuantityMetadata

      Metadata getMinQuantityMetadata()
      Gets the metadata for the minimum quantity.
      Returns:
      metadata for the minumim quantity
      Compliance:
      mandatory - This method must be implemented.

    • setMinimumQuantity

      void setMinimumQuantity(long minQuantity)
      Sets the minimum quantity.
      Parameters:
      minQuantity - the new minumim quantity
      Throws:
      InvalidArgumentException - minQuantity is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumQuantity

      void clearMinimumQuantity()
      Clears the minimum quantity.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMaxQuantityMetadata

      Metadata getMaxQuantityMetadata()
      Gets the metadata for the minimum quantity.
      Returns:
      metadata for the maximum quantity
      Compliance:
      mandatory - This method must be implemented.

    • setMaximumQuantity

      void setMaximumQuantity(long minQuantity)
      Sets the maximum quantity.
      Parameters:
      minQuantity - the new maximum quantity
      Throws:
      InvalidArgumentException - maxQuantity is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMaximumQuantity

      void clearMaximumQuantity()
      Clears the maximum quantity.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getPriceEnablerFormRecord

      PriceEnablerFormRecord getPriceEnablerFormRecord(Type priceEnablerRecordType) throws OperationFailedException
      Gets the PriceEnablerFormRecord corresponding to the given price enabler record Type.
      Parameters:
      priceEnablerRecordType - a price enabler record type
      Returns:
      the price enabler form record
      Throws:
      NullArgumentException - priceEnablerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(priceEnablerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.