Package de.dlr.proseo.interfaces.rest.model

Klasse RestOrder

java.lang.Object
de.dlr.proseo.interfaces.rest.model.RestOrder
Alle implementierten Schnittstellen:
Serializable
public class RestOrder extends Object implements Serializable
Siehe auch:

  • Felddetails

    • serialVersionUID

      static final long serialVersionUID
      Siehe auch:

    • id

      protected Long id
      The persistent id of this object

    • version

      protected Long version
      A version identifier to track updates to the object (especially to detect concurrent update attempts)

    • missionCode

      protected String missionCode
      The mission code (e. g. S5P)

    • identifier

      protected String identifier
      User-defined order identifier

    • uuid

      protected String uuid
      Universally unique order identifier

    • priority

      protected Integer priority
      Priority of the ProcessingOrder (lower number means lower priority; value range 1..100 is defined for the ODIP, but other values are allowed outside On-Demand Production, including negative numbers). Default value is 50.

    • orderState

      protected String orderState
      State of the processing order; one of { INITIAL, APPROVED, RELEASING, RELEASED, PLANNING, PLANNING_FAILED, PLANNED, RUNNING, SUSPENDING, COMPLETED, FAILED, CLOSED }

    • stateMessage

      protected String stateMessage
      Explanatory message describing the reason for the latest state change (mandatory for ProcessingOrders created via the ODIP)

    • orderSource

      protected String orderSource
      Source application for the processing order; one of { CLI, GUI, ODIP, OTHER }

    • submissionTime

      protected Date submissionTime
      Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

    • executionTime

      protected Date executionTime
      Expected execution time (optional, used for scheduling)

    • releaseTime

      protected Date releaseTime
      Date and time at which the ProcessingOrder was received (mandatory for ProcessingOrders created via the ODIP)

    • estimatedCompletionTime

      protected Date estimatedCompletionTime
      Estimated date and time when the output product(s) will be available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP)

    • actualCompletionTime

      protected Date actualCompletionTime
      Date and time when the output product(s) was/were available for download from the (OD)PRIP (mandatory for ProcessingOrders created via the ODIP, once they are in state "COMPLETED")

    • evictionTime

      protected Date evictionTime
      Eviction time (optional, used for automatic order deletion)

    • startTime

      protected String startTime
      The start time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the earliest start time of the selected orbits.

    • stopTime

      protected String stopTime
      The end time of the time interval to process in orbit format (YYYY-MM-DDThh:mm:ss[.SSSSSS]). If a range of orbit numbers is given, this time is set to the latest stop time of the selected orbits.

    • slicingType

      protected String slicingType
      One of { "ORBIT", "CALENDAR_DAY", "CALENDAR_MONTH", "CALENDAR_YEAR", "TIME_SLICE", "NONE" }

    • sliceDuration

      protected Long sliceDuration
      Duration of a slice in seconds (only for slicingType TIME_SLICE)

    • sliceOverlap

      protected Long sliceOverlap
      Overlap between adjacent slices in seconds (applicable for all slicingTypes except NONE, default 0)

    • inputProductReference

      protected RestInputReference inputProductReference
      Identification of the input product to use for On-Demand Production

    • inputFilters

      protected List<RestInputFilter> inputFilters
      Filter conditions to apply to input products

    • dynamicProcessingParameters

      protected List<RestParameter> dynamicProcessingParameters
      Processing option settings (for on-demand processing called "WorkflowOptions" in the ICD); these options will be passed to the data processors in the "Dynamic Processing Parameter" section of the Job Order file

    • classOutputParameters

      protected List<RestClassOutputParameter> classOutputParameters
      Set of parameters to apply to a generated product of the referenced product class replacing the general output parameters

    • outputParameters

      protected List<RestParameter> outputParameters
      Parameters to set for the generated products (may be empty)

    • workflowUuid

      protected String workflowUuid
      Universally unique workflow identifier (only for orders generated through ODIP, mandatory for these)

    • workflowName

      protected String workflowName
      Short name of the applicable workflow (not suitable for identification; only for orders generated through ODIP)

    • configuredProcessors

      protected List<String> configuredProcessors
      List of identifiers of the configured processors (may be empty)

    • orbits

      protected List<RestOrbitQuery> orbits
      List of orbit ranges, identified by spacecraft code and orbit number from/to (may be empty)

    • requestedProductClasses

      protected List<String> requestedProductClasses
      List of internal product types requested as output from the order (at least one is required)

    • inputProductClasses

      protected List<String> inputProductClasses
      List of internal product types provided as input to the order (may be empty)

    • outputFileClass

      protected String outputFileClass
      The file class for the generated output products

    • processingMode

      protected String processingMode
      The processing mode to run the processor(s) in

    • productionType

      protected String productionType
      Production type context, in which the order is running (SYSTEMATIC, ON_DEMAND_DEFAULT, ON_DEMAND_NON_DEFAULT)

    • notificationEndpoint

      protected RestNotificationEndpoint notificationEndpoint
      The endpoint to send order completion notifications to

    • productRetentionPeriod

      protected Long productRetentionPeriod
      Retention period for products generated by this processing order in seconds

    • hasFailedJobSteps

      protected Boolean hasFailedJobSteps
      Indicates whether at least one of the job steps for this order is in state FAILED

    • jobStepStates

      protected List<String> jobStepStates
      The different existing job step states of order

    • percentCompleted

      protected Long percentCompleted
      Percentage of completed job steps

    • percentFailed

      protected Long percentFailed
      Percentage of failed job steps

    • percentRunning

      protected Long percentRunning
      Percentage of running job steps

    • expectedJobs

      protected Long expectedJobs
      Expected jobs for planning and releasing

    • createdJobs

      protected Long createdJobs
      Fully created/released jobs for planning and releasing

  • Konstruktordetails

  • Methodendetails

    • getId

      public Long getId()
      Returns the id.
      Gibt zurück:
      id

    • setId

      public void setId(Long id)
      Set the id.
      Parameter:
      id - the new id

    • getVersion

      public Long getVersion()
      Returns the version.
      Gibt zurück:
      version

    • setVersion

      public void setVersion(Long version)
      Set the version.
      Parameter:
      version - the new version

    • getMissionCode

      @NotNull public @NotNull String getMissionCode()
      Returns the missionCode.
      Gibt zurück:
      missionCode

    • setMissionCode

      public void setMissionCode(String missionCode)
      Set the missionCode.
      Parameter:
      missionCode - the new missionCode

    • getIdentifier

      @NotNull public @NotNull String getIdentifier()
      Returns the identifier.
      Gibt zurück:
      identifier

    • setIdentifier

      public void setIdentifier(String identifier)
      Set the identifier.
      Parameter:
      identifier - the new identifier

    • getUuid

      @Pattern(regexp="^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$") public @Pattern(regexp="^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$") String getUuid()
      Returns the uuid.
      Gibt zurück:
      uuid

    • setUuid

      public void setUuid(String uuid)
      Set the uuid.
      Parameter:
      uuid - the new uuid

    • getPriority

      public Integer getPriority()
      Returns the priority.
      Gibt zurück:
      priority

    • setPriority

      public void setPriority(Integer priority)
      Set the priority.
      Parameter:
      priority - the new priority

    • getOrderState

      @NotNull public @NotNull String getOrderState()
      Returns the orderState.
      Gibt zurück:
      orderState

    • setOrderState

      public void setOrderState(String orderState)
      Set the orderState.
      Parameter:
      orderState - the new orderState

    • getStateMessage

      public String getStateMessage()
      Returns the stateMessage.
      Gibt zurück:
      stateMessage

    • setStateMessage

      public void setStateMessage(String stateMessage)
      Set the stateMessage.
      Parameter:
      stateMessage - the new stateMessage

    • getOrderSource

      public String getOrderSource()
      Returns the orderSource.
      Gibt zurück:
      orderSource

    • setOrderSource

      public void setOrderSource(String orderSource)
      Set the orderSource.
      Parameter:
      orderSource - the new orderSource

    • getSubmissionTime

      public Date getSubmissionTime()
      Returns the submissionTime.
      Gibt zurück:
      submissionTime

    • setSubmissionTime

      public void setSubmissionTime(Date submissionTime)
      Set the submissionTime.
      Parameter:
      submissionTime - the new submissionTime

    • getExecutionTime

      public Date getExecutionTime()
      Returns the executionTime.
      Gibt zurück:
      executionTime

    • setExecutionTime

      public void setExecutionTime(Date executionTime)
      Set the executionTime.
      Parameter:
      executionTime - the new executionTime

    • getReleaseTime

      public Date getReleaseTime()
      Returns the releaseTime.
      Gibt zurück:
      releaseTime

    • setReleaseTime

      public void setReleaseTime(Date releaseTime)
      Set the releaseTime.
      Parameter:
      releaseTime - the new releaseTime

    • getEstimatedCompletionTime

      public Date getEstimatedCompletionTime()
      Returns the estimatedCompletionTime.
      Gibt zurück:
      estimatedCompletionTime

    • setEstimatedCompletionTime

      public void setEstimatedCompletionTime(Date estimatedCompletionTime)
      Set the estimatedCompletionTime.
      Parameter:
      estimatedCompletionTime - the new estimatedCompletionTime

    • getActualCompletionTime

      public Date getActualCompletionTime()
      Returns the actualCompletionTime.
      Gibt zurück:
      actualCompletionTime

    • setActualCompletionTime

      public void setActualCompletionTime(Date actualCompletionTime)
      Set the actualCompletionTime.
      Parameter:
      actualCompletionTime - the new actualCompletionTime

    • getEvictionTime

      public Date getEvictionTime()
      Returns the evictionTime.
      Gibt zurück:
      evictionTime

    • setEvictionTime

      public void setEvictionTime(Date evictionTime)
      Set the evictionTime.
      Parameter:
      evictionTime - the new evictionTime

    • getStartTime

      @Pattern(regexp="^\\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d(.\\d{1,6})?$") public @Pattern(regexp="^\\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d(.\\d{1,6})?$") String getStartTime()
      Returns the startTime.
      Gibt zurück:
      startTime

    • setStartTime

      public void setStartTime(String startTime)
      Set the startTime.
      Parameter:
      startTime - the new startTime

    • getStopTime

      @Pattern(regexp="^\\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d(.\\d{1,6})?$") public @Pattern(regexp="^\\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d(.\\d{1,6})?$") String getStopTime()
      Returns the stopTime.
      Gibt zurück:
      stopTime

    • setStopTime

      public void setStopTime(String stopTime)
      Set the stopTime.
      Parameter:
      stopTime - the new stopTime

    • getSlicingType

      @NotNull public @NotNull String getSlicingType()
      Returns the slicingType.
      Gibt zurück:
      slicingType

    • setSlicingType

      public void setSlicingType(String slicingType)
      Set the slicingType.
      Parameter:
      slicingType - the new slicingType

    • getSliceDuration

      public Long getSliceDuration()
      Returns the sliceDuration.
      Gibt zurück:
      sliceDuration

    • setSliceDuration

      public void setSliceDuration(Long sliceDuration)
      Set the sliceDuration.
      Parameter:
      sliceDuration - the new sliceDuration

    • getSliceOverlap

      public Long getSliceOverlap()
      Returns the sliceOverlap.
      Gibt zurück:
      sliceOverlap

    • setSliceOverlap

      public void setSliceOverlap(Long sliceOverlap)
      Set the sliceOverlap.
      Parameter:
      sliceOverlap - the new sliceOverlap

    • getInputProductReference

      @Valid public @Valid RestInputReference getInputProductReference()
      Returns the inputProductReference.
      Gibt zurück:
      inputProductReference

    • setInputProductReference

      public void setInputProductReference(RestInputReference inputProductReference)
      Set the inputProductReference.
      Parameter:
      inputProductReference - the new inputProductReference

    • getInputFilters

      @Valid public @Valid List<RestInputFilter> getInputFilters()
      Returns the inputFilters.
      Gibt zurück:
      inputFilters

    • setInputFilters

      public void setInputFilters(List<RestInputFilter> inputFilters)
      Set the inputFilters.
      Parameter:
      inputFilters - the new inputFilters

    • getDynamicProcessingParameters

      @Valid public @Valid List<RestParameter> getDynamicProcessingParameters()
      Returns the dynamicProcessingParameters.
      Gibt zurück:
      dynamicProcessingParameters

    • setDynamicProcessingParameters

      public void setDynamicProcessingParameters(List<RestParameter> dynamicProcessingParameters)
      Set the dynamicProcessingParameters.
      Parameter:
      dynamicProcessingParameters - the new dynamicProcessingParameters

    • getClassOutputParameters

      @Valid public @Valid List<RestClassOutputParameter> getClassOutputParameters()
      Returns the classOutputParameters.
      Gibt zurück:
      classOutputParameters

    • setClassOutputParameters

      public void setClassOutputParameters(List<RestClassOutputParameter> classOutputParameters)
      Set the classOutputParameters.
      Parameter:
      classOutputParameters - the new classOutputParameters

    • getOutputParameters

      @NotNull @Valid public @NotNull @Valid List<RestParameter> getOutputParameters()
      Returns the outputParameters.
      Gibt zurück:
      outputParameters

    • setOutputParameters

      public void setOutputParameters(List<RestParameter> outputParameters)
      Set the outputParameters.
      Parameter:
      outputParameters - the new outputParameters

    • getWorkflowUuid

      @Pattern(regexp="^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$") public @Pattern(regexp="^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$") String getWorkflowUuid()
      Returns the workflowUuid.
      Gibt zurück:
      workflowUuid

    • setWorkflowUuid

      public void setWorkflowUuid(String workflowUuid)
      Set the workflowUuid.
      Parameter:
      workflowUuid - the new workflowUuid

    • getWorkflowName

      public String getWorkflowName()
      Returns the workflowName.
      Gibt zurück:
      workflowName

    • setWorkflowName

      public void setWorkflowName(String workflowName)
      Set the workflowName.
      Parameter:
      workflowName - the new workflowName

    • getConfiguredProcessors

      @NotNull public @NotNull List<String> getConfiguredProcessors()
      Returns the configuredProcessors.
      Gibt zurück:
      configuredProcessors

    • setConfiguredProcessors

      public void setConfiguredProcessors(List<String> configuredProcessors)
      Set the configuredProcessors.
      Parameter:
      configuredProcessors - the new configuredProcessors

    • getOrbits

      @NotNull @Valid public @NotNull @Valid List<RestOrbitQuery> getOrbits()
      Returns the orbits.
      Gibt zurück:
      orbits

    • setOrbits

      public void setOrbits(List<RestOrbitQuery> orbits)
      Set the orbits.
      Parameter:
      orbits - the new orbits

    • getRequestedProductClasses

      @NotNull public @NotNull List<String> getRequestedProductClasses()
      Returns the requestedProductClasses.
      Gibt zurück:
      requestedProductClasses

    • setRequestedProductClasses

      public void setRequestedProductClasses(List<String> requestedProductClasses)
      Set the requestedProductClasses.
      Parameter:
      requestedProductClasses - the new requestedProductClasses

    • getInputProductClasses

      @NotNull public @NotNull List<String> getInputProductClasses()
      Returns the inputProductClasses.
      Gibt zurück:
      inputProductClasses

    • setInputProductClasses

      public void setInputProductClasses(List<String> inputProductClasses)
      Set the inputProductClasses.
      Parameter:
      inputProductClasses - the new inputProductClasses

    • getOutputFileClass

      @NotNull public @NotNull String getOutputFileClass()
      Returns the outputFileClass.
      Gibt zurück:
      outputFileClass

    • setOutputFileClass

      public void setOutputFileClass(String outputFileClass)
      Set the outputFileClass.
      Parameter:
      outputFileClass - the new outputFileClass

    • getProcessingMode

      @NotNull public @NotNull String getProcessingMode()
      Returns the processingMode.
      Gibt zurück:
      processingMode

    • setProcessingMode

      public void setProcessingMode(String processingMode)
      Set the processingMode.
      Parameter:
      processingMode - the new processingMode

    • getProductionType

      public String getProductionType()
      Returns the productionType.
      Gibt zurück:
      productionType

    • setProductionType

      public void setProductionType(String productionType)
      Set the productionType.
      Parameter:
      productionType - the new productionType

    • getNotificationEndpoint

      @Valid public @Valid RestNotificationEndpoint getNotificationEndpoint()
      Returns the notificationEndpoint.
      Gibt zurück:
      notificationEndpoint

    • setNotificationEndpoint

      public void setNotificationEndpoint(RestNotificationEndpoint notificationEndpoint)
      Set the notificationEndpoint.
      Parameter:
      notificationEndpoint - the new notificationEndpoint

    • getProductRetentionPeriod

      public Long getProductRetentionPeriod()
      Returns the productRetentionPeriod.
      Gibt zurück:
      productRetentionPeriod

    • setProductRetentionPeriod

      public void setProductRetentionPeriod(Long productRetentionPeriod)
      Set the productRetentionPeriod.
      Parameter:
      productRetentionPeriod - the new productRetentionPeriod

    • getHasFailedJobSteps

      public Boolean getHasFailedJobSteps()
      Returns the hasFailedJobSteps.
      Gibt zurück:
      hasFailedJobSteps

    • setHasFailedJobSteps

      public void setHasFailedJobSteps(Boolean hasFailedJobSteps)
      Set the hasFailedJobSteps.
      Parameter:
      hasFailedJobSteps - the new hasFailedJobSteps

    • getJobStepStates

      public List<String> getJobStepStates()
      Returns the jobStepStates.
      Gibt zurück:
      jobStepStates

    • setJobStepStates

      public void setJobStepStates(List<String> jobStepStates)
      Set the jobStepStates.
      Parameter:
      jobStepStates - the new jobStepStates

    • getPercentCompleted

      public Long getPercentCompleted()
      Returns the percentCompleted.
      Gibt zurück:
      percentCompleted

    • setPercentCompleted

      public void setPercentCompleted(Long percentCompleted)
      Set the percentCompleted.
      Parameter:
      percentCompleted - the new percentCompleted

    • getPercentFailed

      public Long getPercentFailed()
      Returns the percentFailed.
      Gibt zurück:
      percentFailed

    • setPercentFailed

      public void setPercentFailed(Long percentFailed)
      Set the percentFailed.
      Parameter:
      percentFailed - the new percentFailed

    • getPercentRunning

      public Long getPercentRunning()
      Returns the percentRunning.
      Gibt zurück:
      percentRunning

    • setPercentRunning

      public void setPercentRunning(Long percentRunning)
      Set the percentRunning.
      Parameter:
      percentRunning - the new percentRunning

    • getExpectedJobs

      public Long getExpectedJobs()
      Returns the expectedJobs.
      Gibt zurück:
      expectedJobs

    • setExpectedJobs

      public void setExpectedJobs(Long expectedJobs)
      Set the expectedJobs.
      Parameter:
      expectedJobs - the new expectedJobs

    • getCreatedJobs

      public Long getCreatedJobs()
      Returns the createdJobs.
      Gibt zurück:
      createdJobs

    • setCreatedJobs

      public void setCreatedJobs(Long createdJobs)
      Set the createdJobs.
      Parameter:
      createdJobs - the new createdJobs

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • equals

      public boolean equals(Object other)
      Setzt außer Kraft:
      equals in Klasse Object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object