Interface BidForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable
All Known Subinterfaces:
BidBatchForm
public interface BidForm extends OsidRelationshipForm

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

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

  • Method Details

    • getQuantityMetadata

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

    • setQuantity

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

    • clearQuantity

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

    • getMaximumBidMetadata

      Metadata getMaximumBidMetadata()
      Gets the metadata for the maximum bid.
      Returns:
      metadata for the maximum bid
      Compliance:
      mandatory - This method must be implemented.

    • setMaximumBid

      void setMaximumBid(Currency bid)
      Sets the maximum bid.
      Parameters:
      bid - the new maximum bid
      Throws:
      InvalidArgumentException - bid is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - bid is null
      Compliance:
      mandatory - This method must be implemented.

    • clearMaximumBid

      void clearMaximumBid()
      Removes the maximum bid.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getBidFormRecord

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