Class ResultContainer
java.lang.Object
com.inet.taskplanner.server.api.job.JobResultContainer
com.inet.taskplanner.server.api.job.ResultContainer
Class representing the
results
of a job
.
Contains the list of results
from the execution and a flag whether the condition for the job was
fulfilled or not.
- Since:
- taskplanner 3.0
-
Constructor Summary
ConstructorsConstructorDescriptionResultContainer
(List<Result> results) Creates a new ResultContainer instance.Creates a new ResultContainer instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
cleanup()
When result-handling is finished, then this method is called to clean up used system resources, i.e.Returns the flavors supported by this containerReturns the additional meta properties for the job execution.getResults
(ResultFlavor flavor) Returns all results for a certain flavorMethods inherited from class com.inet.taskplanner.server.api.job.JobResultContainer
areResultsProcessable, setAreResultsProcessable
-
Constructor Details
-
ResultContainer
Creates a new ResultContainer instance.- Parameters:
results
- the results from the job execution, can be empty- Since:
- taskplanner 3.0
-
ResultContainer
Creates a new ResultContainer instance.- Parameters:
results
- the results from the job execution, can be emptymetaProperties
- additional meta properties to be used for placeholder replacement- Since:
- taskplanner 3.0
-
-
Method Details
-
getFlavors
Returns the flavors supported by this container- Specified by:
getFlavors
in classJobResultContainer
- Returns:
- the flavors supported by this container
-
getResults
Returns all results for a certain flavor- Specified by:
getResults
in classJobResultContainer
- Parameters:
flavor
- the flavor to get the results for, should be one of the flavors returned byJobResultContainer.getFlavors()
- Returns:
- a list with all results that support the requested flavor, could be an empty list but not
null
-
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- Specified by:
getMetaProperties
in classJobResultContainer
- Returns:
- the meta properties map, not
null
-
cleanup
public 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.- Specified by:
cleanup
in classJobResultContainer
-