Package com.inet.taskplanner.server.api.job

Class JobResultContainer

  • Direct Known Subclasses:
    ResultContainer
    public abstract class JobResultContainer
extends java.lang.Object
    The result to be returned by a Job
    Since:
    taskplanner 3.0

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      boolean areResultsProcessable()
      If the results of this contains are to be processed or not.
      abstract void cleanup()
      When result-handling is finished, then this method is called to clean up used system resources, i.e.
      abstract java.util.List<ResultFlavor> getFlavors()
      Returns the flavors supported by this container
      abstract java.util.Map<java.lang.String,​java.lang.String> getMetaProperties()
      Returns the additional meta properties for the job execution.
      abstract java.util.List<Result> getResults​(ResultFlavor flavor)
      Returns all results for a certain flavor
      void setAreResultsProcessable​(boolean areResultsProcessable)
      Sets If the results of this contains are to be processed or not.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • JobResultContainer

        public JobResultContainer()

    • Method Detail

      • areResultsProcessable

        public boolean areResultsProcessable()
        If the results of this contains are to be processed or not.
        Returns:
        true if the results of this must be normally processed or not
        Since:
        taskplanner 3.0

      • setAreResultsProcessable

        public void setAreResultsProcessable​(boolean areResultsProcessable)
        Sets If the results of this contains are to be processed or not.
        Parameters:
        areResultsProcessable - the areResultsProcessable to set
        Since:
        taskplanner 3.0

      • getFlavors

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

      • getResults

        @Nonnull
public abstract java.util.List<Result> getResults​(@Nonnull
                                                  ResultFlavor flavor)
        Returns all results for a certain flavor
        Parameters:
        flavor - the flavor to get the results for, should be one of the flavors returned by getFlavors()
        Returns:
        a list with all results that support the requested flavor, could be an empty list but not null
        Since:
        taskplanner 3.0

      • getMetaProperties

        @Nonnull
public abstract java.util.Map<java.lang.String,​java.lang.String> getMetaProperties()
        Returns the additional meta properties for the job execution. These properties are supposed to be used for replacing placeholders in textual output formats like email or messengers
        Returns:
        the meta properties map, not null
        Since:
        taskplanner 3.0

      • cleanup

        public abstract void cleanup()
        When result-handling is finished, then this method is called to clean up used system resources, i.e. to delete all created file.

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

        Since:
        taskplanner 3.0