ProgramReportSchedulable (Ametys 4.4.x - API)

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
  - - org.ametys.plugins.odfpilotage.schedulable.AbstractReportSchedulable
    - - org.ametys.plugins.odfpilotage.schedulable.ProgramReportSchedulable

All Implemented Interfaces:

Schedulable, LogEnabled, PluginAware, Component, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ProgramConsistencyExtractSchedulable
```
public class ProgramReportSchedulable
extends AbstractReportSchedulable
```
Schedulable for pilotage report by program.

Nested Class Summary
- Nested classes/interfaces inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
  AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

Fields
Modifier and Type Field Description

static String JOBDATAMAP_PROGRAM_KEY
The key for the program
- Fields inherited from class org.ametys.plugins.odfpilotage.schedulable.AbstractReportSchedulable
  _currentUserProvider, _reportEP, JOBDATAMAP_EXTENSION_ID_KEY, JOBDATAMAP_OUTPUT_FORMAT_KEY
- Fields inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
  _acceptConcurrentExecution, _context, _description, _iconGlyph, _iconLarge, _iconMedium, _iconSmall, _id, _label, _parameters, _pluginName, _private, _schedulableParameterTypeExtensionPoint, _smanager, _userManager

Constructor Summary

Constructors
Constructor Description

ProgramReportSchedulable()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,ElementDefinition>`	`getParameters()`	Get the parameters for job execution
`protected Map<String,String>`	`getReportParameters(JobDataMap jobDataMap)`	Get the report parameters from the schedulable parameters
`PilotageReport.PilotageReportTarget`	`getTarget()`	The target of the report.

Methods inherited from class org.ametys.plugins.odfpilotage.schedulable.AbstractReportSchedulable
configure, execute, forGenericReports, service

Methods inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
acceptConcurrentExecution, contextualize, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, isPrivate, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JOBDATAMAP_PROGRAM_KEY
```
public static final String JOBDATAMAP_PROGRAM_KEY
```
    The key for the program
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProgramReportSchedulable
```
public ProgramReportSchedulable()
```
- Method Detail
  - getTarget
```
public PilotageReport.PilotageReportTarget getTarget()
```
    Description copied from class: AbstractReportSchedulable
    
    The target of the report.
    
    Specified by:
    
    getTarget in class AbstractReportSchedulable
    
    Returns:
    
    The target
  - getReportParameters
```
protected Map<String,String> getReportParameters(JobDataMap jobDataMap)
```
    Description copied from class: AbstractReportSchedulable
    
    Get the report parameters from the schedulable parameters
    
    Overrides:
    
    getReportParameters in class AbstractReportSchedulable
    
    Parameters:
    
    jobDataMap - The schedulable parameters
    
    Returns:
    
    The report parameters
  - getParameters
```
public Map<String,ElementDefinition> getParameters()
```
    Description copied from interface: Schedulable
    
    Get the parameters for job execution
    
    Specified by:
    
    getParameters in interface Schedulable
    
    Overrides:
    
    getParameters in class AbstractStaticSchedulable
    
    Returns:
    
    the parameters