Class JobResultContainer

java.lang.Object
com.inet.taskplanner.server.api.job.JobResultContainer
Direct Known Subclasses:
ResultContainer
public abstract class JobResultContainer extends Object
The result container returned by a Job.
Since:
taskplanner 3.0

  • Constructor Details

    • JobResultContainer

      public JobResultContainer()

  • Method Details

    • areResultsProcessable

      public boolean areResultsProcessable()
      Returns whether the results in this container should be processed.
      Returns:
      true if the results should normally be processed; otherwise false
      Since:
      taskplanner 3.0

    • setAreResultsProcessable

      public void setAreResultsProcessable(boolean areResultsProcessable)
      Sets whether the results in this container should be processed.
      Parameters:
      areResultsProcessable - whether the results should be processed
      Since:
      taskplanner 3.0

    • getFlavors

      public abstract @Nonnull List<ResultFlavor> getFlavors()
      Returns the flavors supported by this container
      Returns:
      the flavors supported by this container
      Since:
      taskplanner 3.0

    • getResults

      public abstract @Nonnull List<Result> getResults(@Nonnull ResultFlavor flavor)
      Returns all results for a certain flavor
      Parameters:
      flavor - the flavor for which to get results; should be one of the flavors returned by getFlavors()
      Returns:
      a list of all results that support the requested flavor; can be empty but is never null
      Since:
      taskplanner 3.0

    • getMetaProperties

      public abstract @Nonnull Map<String,String> getMetaProperties()
      Returns the additional metadata properties for the job execution. These properties can be used to replace placeholders in textual output formats such as email or messengers.
      Returns:
      the meta properties map, not null
      Since:
      taskplanner 3.0

    • cleanup

      public abstract void cleanup()
      When result handling is finished, this method is called to release resources held by the results, such as closing streams or deleting temporary files as appropriate.

      This is also called if no appropriate ResultAction handled this result.

      Since:
      taskplanner 3.0