Package de.dlr.proseo.model

Class OrderTemplate

java.lang.Object
de.dlr.proseo.model.PersistentObject
de.dlr.proseo.model.OrderTemplateBase
de.dlr.proseo.model.OrderTemplate
@Entity public class OrderTemplate extends OrderTemplateBase
This class aims at simplifying the generation of processing orders, either for automatic generation due to an OrderTrigger firing, or for manual generation, e. g. from the GUI or CLI. The template specifies values for various attributes to be set in a ProcessingOrder.
Since:
prosEO 2.1.0
Author:
Dr. Thomas Bassler

  • Constructor Details

    • OrderTemplate

      public OrderTemplate()

  • Method Details

    • getProductionType

      public ProductionType getProductionType()
      Returns:
      the productionType

    • setProductionType

      public void setProductionType(ProductionType productionType)
      Parameters:
      productionType - the productionType to set

    • getDynamicProcessingParameters

      public Map<String,Parameter> getDynamicProcessingParameters()
      Gets the dynamic processing parameters to be set for the Job Orders in this order
      Returns:
      the dynamicProcessingParameters

    • setDynamicProcessingParameters

      public void setDynamicProcessingParameters(Map<String,Parameter> dynamicProcessingParameters)
      Sets the dynamic processing parameters to be set for the Job Orders in this order
      Parameters:
      dynamicProcessingParameters - the dynamicProcessingParameters to set

    • getRequestedProductClasses

      public Set<ProductClass> getRequestedProductClasses()
      Gets the requested product classes
      Returns:
      the requestedProductClasses

    • setRequestedProductClasses

      public void setRequestedProductClasses(Set<ProductClass> requestedProductClasses)
      Sets the requested product classes
      Parameters:
      requestedProductClasses - the requestedProductClasses to set

    • getInputProductClasses

      public Set<ProductClass> getInputProductClasses()
      Gets the input product classes provided to the order
      Returns:
      the input product classes

    • setInputProductClasses

      public void setInputProductClasses(Set<ProductClass> inputProductClasses)
      Sets the input product classes provided to the order
      Parameters:
      inputProductClasses - the input product classes to set

    • getNotificationEndpoint

      public NotificationEndpoint getNotificationEndpoint()
      Returns:
      the notificationEndpoint

    • setNotificationEndpoint

      public void setNotificationEndpoint(NotificationEndpoint notificationEndpoint)
      Parameters:
      notificationEndpoint - the notificationEndpoint to set

    • getProductRetentionPeriod

      public Duration getProductRetentionPeriod()
      Gets the retention period for products generated by this processing order
      Returns:
      the product retention period

    • setProductRetentionPeriod

      public void setProductRetentionPeriod(Duration productRetentionPeriod)
      Sets the retention period for products generated by this processing order
      Parameters:
      productRetentionPeriod - the product retention period to set

    • isAutoRelease

      public boolean isAutoRelease()
      Indicates whether a processing order reaching state PLANNED will automatically be released
      Returns:
      true, if the order will be released automatically, false otherwise

    • setAutoRelease

      public void setAutoRelease(boolean autoRelease)
      Sets a flag indicating whether a processing order reaching state PLANNED shall automatically be released
      Parameters:
      autoRelease - set to true, if the order shall be released automatically, and to false otherwise

    • isAutoClose

      public boolean isAutoClose()
      Indicates whether a processing order reaching state COMPLETED will automatically be closed
      Returns:
      true, if the order will be closed automatically, false otherwise

    • setAutoClose

      public void setAutoClose(boolean autoClose)
      Sets a flag indicating whether a processing order reaching state COMPLETED shall automatically be closed
      Parameters:
      autoClose - set to true, if the order shall be closed automatically, and to false otherwise

    • getInputDataTimeoutPeriod

      public Duration getInputDataTimeoutPeriod()
      Gets the period of time, after which the order will fail or will automatically be started regardless of input data availability
      Returns:
      the input data timeout period

    • setInputDataTimeoutPeriod

      public void setInputDataTimeoutPeriod(Duration inputDataTimeoutPeriod)
      Sets the period of time, after which the order shall fail or shall automatically be started regardless of input data availability
      Parameters:
      inputDataTimeoutPeriod - the input data timeout period to set

    • isOnInputDataTimeoutFail

      public boolean isOnInputDataTimeoutFail()
      Indicates whether the order will fail after the input data timeout period has elapsed
      Returns:
      true, if the order will fail after timeout, false, if it will be processed with incomplete input data

    • setOnInputDataTimeoutFail

      public void setOnInputDataTimeoutFail(boolean onInputDataTimeoutFail)
      Sets a flag indicating whether the order will fail after the input data timeout period has elapsed
      Parameters:
      onInputDataTimeoutFail - set to true, if the order shall fail after timeout, and to false, if it shall be processed with incomplete input data

    • getRequestedConfiguredProcessors

      public Set<ConfiguredProcessor> getRequestedConfiguredProcessors()
      Gets the requested configured processors
      Returns:
      the requestedConfiguredProcessors

    • setRequestedConfiguredProcessors

      public void setRequestedConfiguredProcessors(Set<ConfiguredProcessor> requestedConfiguredProcessors)
      Sets the requested configured processors
      Parameters:
      requestedConfiguredProcessors - the requestedConfiguredProcessors to set

    • toString

      public String toString()
      Overrides:
      toString in class OrderTemplateBase