Package org.ametys.plugins.forms.schedulable

Class ExportXlsSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

org.ametys.cms.schedule.AbstractSendingMailSchedulable

org.ametys.plugins.forms.schedulable.ExportXlsSchedulable

All Implemented Interfaces:

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

public class ExportXlsSchedulable
extends AbstractSendingMailSchedulable

Schedulable for form xls export

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
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SourceResolver	_sourceResolver	The avalon source resolver.
static final String	FORM_EXPORT_XLS_DIR_NAME	The directory under ametys home data directory for form xls export
static final String	PARAM_FORM_ID	Scheduler parameter name for form id

Fields inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_currentUserProvider, _i18nUtils, _mailSender, _sysadminMail, _userHelper

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, _startTime, _userManager, PROGRESSION_TRACKER

Constructor Summary

Constructors

Constructor	Description
ExportXlsSchedulable()

Method Summary

Modifier and Type	Method	Description
protected void	_doExecute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	Executes the schedulable.
protected void	_generateFormExportXls(File xslExportDirectory, Form form)	Generate the form xls export
protected String	_getDownloadLink(Form form)	Get the link to download form xls export
protected String	_getErrorMailBody(JobExecutionContext context, Throwable throwable)	Retrieves the body of the error mail
protected I18nizableText	_getErrorMailSubject(JobExecutionContext context)	Retrieves the subject of the error mail
protected String	_getSuccessMailBody(JobExecutionContext context)	Retrieves the body of the success mail
protected I18nizableText	_getSuccessMailSubject(JobExecutionContext context)	Retrieves the subject of the success mail
protected boolean	_isMailBodyInHTML(JobExecutionContext context)	Determines if the mail body is in HTML
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_getRecipient, _sendMail, execute, initialize

Methods inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

acceptConcurrentExecution, configure, contextualize, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, getParameters, getProgressionTracker, 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 Details

FORM_EXPORT_XLS_DIR_NAME

public static final String FORM_EXPORT_XLS_DIR_NAME

The directory under ametys home data directory for form xls export

See Also:

• Constant Field Values

PARAM_FORM_ID

public static final String PARAM_FORM_ID

Scheduler parameter name for form id

See Also:

• Constant Field Values

_sourceResolver

protected SourceResolver _sourceResolver

The avalon source resolver.

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

Constructor Details

ExportXlsSchedulable

public ExportXlsSchedulable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSendingMailSchedulable

Throws:

ServiceException

_doExecute

protected void _doExecute(JobExecutionContext context,
 ContainerProgressionTracker progressionTracker)
                   throws Exception

Description copied from class: AbstractSendingMailSchedulable

Executes the schedulable.

Specified by:

_doExecute in class AbstractSendingMailSchedulable

Parameters:

context - the context

progressionTracker - The progression tracker

Throws:

Exception - if an error occurred

_getSuccessMailSubject

protected I18nizableText _getSuccessMailSubject(JobExecutionContext context)

Description copied from class: AbstractSendingMailSchedulable

Retrieves the subject of the success mail

Specified by:

_getSuccessMailSubject in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the subject of the success mail

_getErrorMailSubject

protected I18nizableText _getErrorMailSubject(JobExecutionContext context)

Description copied from class: AbstractSendingMailSchedulable

Retrieves the subject of the error mail

Specified by:

_getErrorMailSubject in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the subject of the error mail

_isMailBodyInHTML

protected boolean _isMailBodyInHTML(JobExecutionContext context)
                             throws Exception

Description copied from class: AbstractSendingMailSchedulable

Determines if the mail body is in HTML

Overrides:

_isMailBodyInHTML in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

true if the mail body is in HTML, false otherwise

Throws:

Exception - If an error occurs while retrieving if mail body should be HTML

_getSuccessMailBody

protected String _getSuccessMailBody(JobExecutionContext context)
                              throws IOException

Description copied from class: AbstractSendingMailSchedulable

Retrieves the body of the success mail

Specified by:

_getSuccessMailBody in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the body of the success mail

Throws:

IOException

_getDownloadLink

protected String _getDownloadLink(Form form)
                           throws IOException

Get the link to download form xls export

Parameters:

form - the form

Returns:

the download link

Throws:

IOException - if failed to build the download uri

_getErrorMailBody

protected String _getErrorMailBody(JobExecutionContext context,
 Throwable throwable)

Description copied from class: AbstractSendingMailSchedulable

Retrieves the body of the error mail

Specified by:

_getErrorMailBody in class AbstractSendingMailSchedulable

Parameters:

context - the context

throwable - the error

Returns:

the body of the error mail

_generateFormExportXls

protected void _generateFormExportXls(File xslExportDirectory,
 Form form)
                               throws IOException

Generate the form xls export

Parameters:

xslExportDirectory - the xls export directory

form - the form

Throws:

IOException - if an error occured with files