Class AbstractReportSchedulable
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
org.ametys.plugins.odfpilotage.schedulable.AbstractReportSchedulable
- All Implemented Interfaces:
Schedulable
,LogEnabled
,PluginAware
,Component
,Configurable
,Contextualizable
,Serviceable
- Direct Known Subclasses:
OrgUnitReportSchedulable
,ProgramReportSchedulable
Schedulable
for pilotage report.-
Nested Class Summary
Nested classes/interfaces inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
AbstractStaticSchedulable.SchedulableParameterParser
-
Field Summary
Modifier and TypeFieldDescriptionprotected CurrentUserProvider
The current user providerprotected ReportExtensionPoint
The report extension pointstatic final String
The key for the extension IDstatic final String
The key for the output formatFields 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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(Configuration configuration) void
execute
(JobExecutionContext context) The action to perform when a trigger is fired.boolean
The schedulable is written for generic reports or it has additional parameters.getReportParameters
(JobDataMap jobDataMap) Get the report parameters from the schedulable parametersabstract PilotageReport.PilotageReportTarget
The target of the report.void
service
(ServiceManager manager) Methods inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
acceptConcurrentExecution, contextualize, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, getParameters, isPrivate, setPluginInfo
Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger
-
Field Details
-
JOBDATAMAP_EXTENSION_ID_KEY
The key for the extension ID- See Also:
-
JOBDATAMAP_OUTPUT_FORMAT_KEY
The key for the output format- See Also:
-
_reportEP
The report extension point -
_currentUserProvider
The current user provider
-
-
Constructor Details
-
AbstractReportSchedulable
public AbstractReportSchedulable()
-
-
Method Details
-
configure
- Specified by:
configure
in interfaceConfigurable
- Overrides:
configure
in classAbstractStaticSchedulable
- Throws:
ConfigurationException
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractStaticSchedulable
- Throws:
ServiceException
-
execute
Description copied from interface:Schedulable
The action to perform when a trigger is fired. Do not manually call this method.- Specified by:
execute
in interfaceSchedulable
- Specified by:
execute
in classAbstractStaticSchedulable
- Parameters:
context
- the context- Throws:
Exception
- if an error occured
-
getTarget
The target of the report.- Returns:
- The target
-
forGenericReports
The schedulable is written for generic reports or it has additional parameters.- Returns:
true
if the schedulable is only for generic reports.
-
getReportParameters
Get the report parameters from the schedulable parameters- Parameters:
jobDataMap
- The schedulable parameters- Returns:
- The report parameters
-