Interface ShipmentForm

All Superinterfaces:
Extensible, Identifiable, OsidAggregateableForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
All Known Subinterfaces:
ShipmentBatchForm
public interface ShipmentForm extends OsidObjectForm, OsidAggregateableForm

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

  • Method Details

    • getSourceMetadata

      Metadata getSourceMetadata()
      Gets the metadata for a source.
      Returns:
      metadata for the source
      Compliance:
      mandatory - This method must be implemented.

    • setSource

      void setSource(Id resourceId)
      Sets the source.
      Parameters:
      resourceId - the new source
      Throws:
      InvalidArgumentException - resourceId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSource

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

    • getOrderMetadata

      Metadata getOrderMetadata()
      Gets the metadata for an odrer.
      Returns:
      metadata for the order
      Compliance:
      mandatory - This method must be implemented.

    • setOrder

      void setOrder(Id orderId)
      Sets the order.
      Parameters:
      orderId - the new order
      Throws:
      InvalidArgumentException - orderId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - orderId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearOrder

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

    • getDateMetadata

      Metadata getDateMetadata()
      Gets the metadata for the shipment date.
      Returns:
      metadata for the date
      Compliance:
      mandatory - This method must be implemented.

    • setDate

      void setDate(DateTime date)
      Sets the date.
      Parameters:
      date - the new date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDate

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

    • getShipmentFormRecord

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