Package com.inet.report.taskplanner
Class ReportJobFactory
java.lang.Object
com.inet.taskplanner.server.api.common.AbstractFactory<COMPONENT,DEFINITION,INFO,SUMMARY>
com.inet.taskplanner.server.api.common.SeriesDependentFactory<T,com.inet.taskplanner.server.api.job.JobDefinition,com.inet.taskplanner.server.api.job.JobInfo,com.inet.taskplanner.server.api.job.JobSummaryInfo>
com.inet.taskplanner.server.api.job.JobFactory<com.inet.report.taskplanner.ReportJob>
com.inet.report.taskplanner.ReportJobFactory
- All Implemented Interfaces:
com.inet.plugin.NamedExtension
public class ReportJobFactory
extends com.inet.taskplanner.server.api.job.JobFactory<com.inet.report.taskplanner.ReportJob>
The reporting job factory.
- Since:
- 17.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The extension name used to create aJobDefinition
.static final String
The prompts property used to create aJobDefinition
.Fields inherited from class com.inet.taskplanner.server.api.common.SeriesDependentFactory
PLACEHOLDER_END_CHARACTER, PLACEHOLDER_START_CHARACTER
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected com.inet.report.taskplanner.ReportJob
createInstanceFrom
(com.inet.taskplanner.server.api.job.JobDefinition definition, com.inet.id.GUID taskID) com.inet.taskplanner.server.api.job.JobInfo
getInformation
(com.inet.id.GUID taskID) List<com.inet.taskplanner.server.api.result.ResultFlavor>
getResultFlavors
(com.inet.taskplanner.server.api.job.JobDefinition definition) com.inet.taskplanner.server.api.job.JobSummaryInfo
getSummary
(com.inet.taskplanner.server.api.job.JobDefinition definition) updateValues
(com.inet.taskplanner.server.api.job.JobDefinition patchedDefinition, com.inet.taskplanner.server.api.job.JobDefinition unpatchedDefinition, com.inet.taskplanner.server.api.series.SeriesDefinition seriesDefinition, com.inet.id.GUID taskID) void
validate
(com.inet.taskplanner.server.api.job.JobDefinition definition, com.inet.id.GUID taskID) void
validateCondition
(com.inet.taskplanner.server.api.job.JobDefinition definition) Methods inherited from class com.inet.taskplanner.server.api.job.JobFactory
patchDefinitionProperties, validateCondition
Methods inherited from class com.inet.taskplanner.server.api.common.SeriesDependentFactory
createFrom, getFirstValueFromSeries, updateValues, validate
Methods inherited from class com.inet.taskplanner.server.api.common.AbstractFactory
checkDefinitionArgument, createInstanceFrom, getExtensionName, isAvailable
-
Field Details
-
EXTENSION
The extension name used to create aJobDefinition
. Most reporting properties for the JobDefinition can be found at https://www.inetsoftware.de/documentation/clear-reports/plugins/clear-reports/documentation/en/report-url-parameters- See Also:
-
PROMPTS
The prompts property used to create aJobDefinition
. The value is a Json string with an array. The elements of the array must contains the fields "key" and "value". The key hold the prompt name.- See Also:
-
-
Constructor Details
-
ReportJobFactory
public ReportJobFactory()Create a instance of the factory- Since:
- 17.0
-
-
Method Details
-
getInformation
public com.inet.taskplanner.server.api.job.JobInfo getInformation(@Nullable com.inet.id.GUID taskID) - Specified by:
getInformation
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.report.taskplanner.ReportJob,
com.inet.taskplanner.server.api.job.JobDefinition, com.inet.taskplanner.server.api.job.JobInfo, com.inet.taskplanner.server.api.job.JobSummaryInfo>
-
updateValues
public Map<String,String> updateValues(com.inet.taskplanner.server.api.job.JobDefinition patchedDefinition, com.inet.taskplanner.server.api.job.JobDefinition unpatchedDefinition, com.inet.taskplanner.server.api.series.SeriesDefinition seriesDefinition, com.inet.id.GUID taskID) - Overrides:
updateValues
in classcom.inet.taskplanner.server.api.common.SeriesDependentFactory<com.inet.report.taskplanner.ReportJob,
com.inet.taskplanner.server.api.job.JobDefinition, com.inet.taskplanner.server.api.job.JobInfo, com.inet.taskplanner.server.api.job.JobSummaryInfo>
-
validate
public void validate(com.inet.taskplanner.server.api.job.JobDefinition definition, com.inet.id.GUID taskID) throws com.inet.taskplanner.server.api.error.ValidationException - Specified by:
validate
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.report.taskplanner.ReportJob,
com.inet.taskplanner.server.api.job.JobDefinition, com.inet.taskplanner.server.api.job.JobInfo, com.inet.taskplanner.server.api.job.JobSummaryInfo> - Throws:
com.inet.taskplanner.server.api.error.ValidationException
-
validateCondition
public void validateCondition(com.inet.taskplanner.server.api.job.JobDefinition definition) throws com.inet.taskplanner.server.api.error.ValidationException - Specified by:
validateCondition
in classcom.inet.taskplanner.server.api.job.JobFactory<com.inet.report.taskplanner.ReportJob>
- Throws:
com.inet.taskplanner.server.api.error.ValidationException
-
createInstanceFrom
protected com.inet.report.taskplanner.ReportJob createInstanceFrom(com.inet.taskplanner.server.api.job.JobDefinition definition, com.inet.id.GUID taskID) - Overrides:
createInstanceFrom
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.report.taskplanner.ReportJob,
com.inet.taskplanner.server.api.job.JobDefinition, com.inet.taskplanner.server.api.job.JobInfo, com.inet.taskplanner.server.api.job.JobSummaryInfo>
-
getSummary
public com.inet.taskplanner.server.api.job.JobSummaryInfo getSummary(@Nonnull com.inet.taskplanner.server.api.job.JobDefinition definition) - Specified by:
getSummary
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.report.taskplanner.ReportJob,
com.inet.taskplanner.server.api.job.JobDefinition, com.inet.taskplanner.server.api.job.JobInfo, com.inet.taskplanner.server.api.job.JobSummaryInfo>
-
getResultFlavors
public List<com.inet.taskplanner.server.api.result.ResultFlavor> getResultFlavors(com.inet.taskplanner.server.api.job.JobDefinition definition) - Specified by:
getResultFlavors
in classcom.inet.taskplanner.server.api.job.JobFactory<com.inet.report.taskplanner.ReportJob>
-