Package de.dlr.proseo.model

Class ProcessingOrder

java.lang.Object
de.dlr.proseo.model.PersistentObject
de.dlr.proseo.model.ProcessingOrder
@Entity public class ProcessingOrder extends PersistentObject
A customer order to process a specific set of ProductClasses for a specific period of time using a specific set of ConfiguredProcessors. An order may have properties like a product quality indicator (test vs operational), specific product delivery endpoints, specific (potentially mission-dependent) product generation attributes (e. g. a Copernicus collection number) etc.
Author:
Dr. Thomas Bassler

  • Constructor Details

    • ProcessingOrder

      public ProcessingOrder()

  • Method Details

    • getMission

      public Mission getMission()
      Gets the owning mission
      Returns:
      the mission

    • setMission

      public void setMission(Mission mission)
      Sets the owning mission
      Parameters:
      mission - the mission to set

    • getIdentifier

      public String getIdentifier()
      Gets the user-defined identifier
      Returns:
      the identifier

    • setIdentifier

      public void setIdentifier(String identifier)
      Sets the user-defined identifier
      Parameters:
      identifier - the identifier to set

    • getUuid

      public UUID getUuid()
      Gets the universally unique identifier (UUID)
      Returns:
      the UUID

    • setUuid

      public void setUuid(UUID uuid)
      Sets the universally unique identifier (UUID)
      Parameters:
      uuid - the UUID to set

    • getPriority

      public Integer getPriority()
      Gets the priority value for scheduling
      Returns:
      the priority

    • setPriority

      public void setPriority(Integer priority)
      Sets the priority value for scheduling
      Parameters:
      priority - the priority to set

    • getOrderState

      public OrderState getOrderState()
      Gets the state of the processing order
      Returns:
      the orderState

    • setOrderState

      @Transactional public void setOrderState(OrderState orderState) throws IllegalStateException
      Sets the state of the processing order
      Parameters:
      orderState - the orderState to set
      Throws:
      IllegalStateException - if the intended order state transition is illegal

    • checkStateChange

      @Transactional public void checkStateChange()
      Check whether a processing order state change is required based on the current state of the contained jobs

    • getStateMessage

      public String getStateMessage()
      Gets a message explaining the latest state change
      Returns:
      the state message

    • setStateMessage

      public void setStateMessage(String stateMessage)
      Sets a message explaining the latest state change
      Parameters:
      stateMessage - the state message to set

    • getOrderSource

      public OrderSource getOrderSource()
      Gets the source application for the order
      Returns:
      the order source

    • setOrderSource

      public void setOrderSource(OrderSource orderSource)
      Sets the source application for the order
      Parameters:
      orderSource - the order source to set

    • getSubmissionTime

      public Instant getSubmissionTime()
      Gets the date and time the order was received
      Returns:
      the submission time

    • setSubmissionTime

      public void setSubmissionTime(Instant submissionTime)
      Sets the date and time the order was received
      Parameters:
      submissionTime - the submission time to set

    • getExecutionTime

      public Instant getExecutionTime()
      Gets the scheduled execution time (if any)
      Returns:
      the executionTime (may be null)

    • setExecutionTime

      public void setExecutionTime(Instant executionTime)
      Sets the scheduled execution time
      Parameters:
      executionTime - the executionTime to set (a null value removes an existing execution time)

    • getReleaseTime

      public Instant getReleaseTime()
      Gets the date and time the order was released for processing
      Returns:
      the releaseTime

    • setReleaseTime

      public void setReleaseTime(Instant releaseTime)
      Sets the date and time the order was released for processing
      Parameters:
      releaseTime - the releaseTime to set

    • getEstimatedCompletionTime

      public Instant getEstimatedCompletionTime()
      Gets the date and time the order is expected to be completed
      Returns:
      the estimated completion time

    • setEstimatedCompletionTime

      public void setEstimatedCompletionTime(Instant estimatedCompletionTime)
      Sets the date and time the order is expected to be completed
      Parameters:
      estimatedCompletionTime - the estimated completion time to set

    • getActualCompletionTime

      public Instant getActualCompletionTime()
      Gets the date and time the order was actually completed
      Returns:
      the actualCompletionTime

    • setActualCompletionTime

      public void setActualCompletionTime(Instant actualCompletionTime)
      Sets the date and time the order was actually completed
      Parameters:
      actualCompletionTime - the actualCompletionTime to set

    • getEvictionTime

      public Instant getEvictionTime()
      Gets the order eviction time (if any)
      Returns:
      the eviction time

    • setEvictionTime

      public void setEvictionTime(Instant evictionTime)
      Sets the order eviction time
      Parameters:
      evictionTime - the eviction time to set (may be null)

    • getStartTime

      public Instant getStartTime()
      Gets the (earliest) start time of the processing time interval
      Returns:
      the startTime

    • setStartTime

      public void setStartTime(Instant startTime)
      Sets the (earliest) start time of the processing time interval
      Parameters:
      startTime - the startTime to set

    • getStopTime

      public Instant getStopTime()
      Gets the (latest) stop time of the processing time interval
      Returns:
      the stopTime

    • setStopTime

      public void setStopTime(Instant stopTime)
      Sets the (latest) stop time of the processing time interval
      Parameters:
      stopTime - the stopTime to set

    • getSlicingType

      public OrderSlicingType getSlicingType()
      Gets the method for partitioning the orbit time interval
      Returns:
      the slicingType the order slicing type

    • setSlicingType

      public void setSlicingType(OrderSlicingType slicingType)
      Sets the method for partitioning the orbit time interval. If the slicing type is set to TIME_SLICE and the slice duration has not yet been set, then the slice duration will be set to a default value of one day; for other slicing types the current slice duration will be deleted. If the slicing type is set to NONE, the slice overlap will be set to zero.
      Parameters:
      slicingType - the slicing type to set

    • getSliceDuration

      public Duration getSliceDuration()
      Gets the duration for a single slice
      Returns:
      the slice duration for slicing type TIME_SLICE, null otherwise

    • setSliceDuration

      public void setSliceDuration(Duration sliceDuration) throws IllegalStateException
      Sets the duration for a single slice (for slicing type TIME_SLICE only)
      Parameters:
      sliceDuration - the sliceDuration to set
      Throws:
      IllegalStateException - if setting a slice duration for orders with slicing type other than TIME_SLICE is attempted

    • getSliceOverlap

      public Duration getSliceOverlap()
      Gets the overlap time between slices
      Returns:
      the slice overlap

    • setSliceOverlap

      public void setSliceOverlap(Duration sliceOverlap) throws IllegalStateException
      Sets the overlap time between slices
      Parameters:
      sliceOverlap - the slice overlap to set
      Throws:
      IllegalStateException - if setting an overlap other than 0 for orders with slicing type NONE is attempted

    • getInputProductReference

      public InputProductReference getInputProductReference()
      Returns:
      the inputProductReference

    • setInputProductReference

      public void setInputProductReference(InputProductReference inputProductReference)
      Parameters:
      inputProductReference - the inputProductReference to set

    • getInputFilters

      public Map<ProductClass,InputFilter> getInputFilters()
      Gets the input filters
      Returns:
      the input filters

    • setInputFilters

      public void setInputFilters(Map<ProductClass,InputFilter> inputFilters)
      Sets the input filters
      Parameters:
      inputFilters - the input filters 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

    • getClassOutputParameters

      public Map<ProductClass,ClassOutputParameter> getClassOutputParameters()
      Gets the class-specific output parameters
      Returns:
      the class-specific output parameters

    • setClassOutputParameters

      public void setClassOutputParameters(Map<ProductClass,ClassOutputParameter> classOutputParameters)
      Sets the class-specific output parameters
      Parameters:
      classOutputParameters - the class-specific output parameters to set

    • getOutputParameters

      public Map<String,Parameter> getOutputParameters()
      Gets the output parameters
      Returns:
      the outputParameters

    • getOutputParameters

      public Map<String,Parameter> getOutputParameters(ProductClass productClass)
      Gets the output parameters for a specific product class (class-specific, if available, general otherwise)
      Parameters:
      productClass - the product class to get the parameters for
      Returns:
      the output parameters

    • setOutputParameters

      public void setOutputParameters(Map<String,Parameter> outputParameters)
      Sets the output parameters
      Parameters:
      outputParameters - the output parameters 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

    • getOutputFileClass

      public String getOutputFileClass()
      Gets the file class of the output products
      Returns:
      the outputFileClass

    • setOutputFileClass

      public void setOutputFileClass(String outputFileClass)
      Sets the file class for the output products
      Parameters:
      outputFileClass - the outputFileClass to set

    • getProcessingMode

      public String getProcessingMode()
      Gets the processing mode for the processors
      Returns:
      the processingMode

    • setProcessingMode

      public void setProcessingMode(String processingMode)
      Sets the processing mode for the processors
      Parameters:
      processingMode - the processingMode to set

    • getProductionType

      public ProductionType getProductionType()
      Gets the production type context
      Returns:
      the production type

    • setProductionType

      public void setProductionType(ProductionType productionType)
      Sets the production type context
      Parameters:
      productionType - the production type 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

    • getHasFailedJobSteps

      public Boolean getHasFailedJobSteps()
      Checks whether the order has failed job steps
      Returns:
      true, if at least one job step is in FAILED state, false otherwise

    • hasFailedJobSteps

      public Boolean hasFailedJobSteps()
      Checks whether the order has failed job steps (convenience method for getHasFailedJobSteps())
      Returns:
      true, if at least one job step is in FAILED state, false otherwise

    • setHasFailedJobSteps

      public void setHasFailedJobSteps(Boolean hasFailedJobSteps)
      Sets whether the order has failed job steps
      Parameters:
      hasFailedJobSteps - set to true, when a job step for this order fails

    • getWorkflow

      public Workflow getWorkflow()
      Get the workflow
      Returns:
      the workflow

    • setWorkflow

      public void setWorkflow(Workflow workflow)
      Set the workflow
      Parameters:
      workflow - the workflow to set

    • 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

    • getRequestedOrbits

      public List<Orbit> getRequestedOrbits()
      Gets the requested orbits
      Returns:
      the requestedOrbits

    • setRequestedOrbits

      public void setRequestedOrbits(List<Orbit> requestedOrbits)
      Sets the requested orbits
      Parameters:
      requestedOrbits - the requestedOrbits to set

    • getJobs

      public Set<Job> getJobs()
      Gets the processing jobs
      Returns:
      the jobs

    • setJobs

      public void setJobs(Set<Job> jobs)
      Sets the processing jobs
      Parameters:
      jobs - the jobs to set

    • getMonOrderProgress

      public Set<MonOrderProgress> getMonOrderProgress()
      Gets the order progress monitoring data
      Returns:
      the order progress monitoring data

    • setMonOrderProgress

      public void setMonOrderProgress(Set<MonOrderProgress> monOrderProgress)
      Sets the order progress monitoring data
      Parameters:
      monOrderProgress - the order progress monitoring data to set

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PersistentObject

    • equals

      public boolean equals(Object obj)
      Description copied from class: PersistentObject
      Test equality of persistent objects based on their unique ID.
      Overrides:
      equals in class PersistentObject
      Parameters:
      obj - the object to compare this object to
      Returns:
      true, if obj is a persistent object and has the same ID, false otherwise
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object