Package org.ametys.core.ui

Class AddTaskClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.core.ui.AddTaskClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

AddReportTaskClientSideElement, ApogeeGlobalSynchronizationClientSideElement, ExportClientSiteElement, GlobalSynchronizationClientSideElement, SelectionAwareAddTaskClientSideElement

public class AddTaskClientSideElement
extends StaticClientSideElement
implements Contextualizable

This implementation creates an element for adding a new task

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The Avalon context
protected LogManager	_logManager	The log manager
protected Scheduler	_scheduler	The Ametys scheduler

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
AddTaskClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected String	_configureClass(Configuration configuration)	Configure the js class name
protected Map<String,List<String>>	_configureDependencies(Configuration configuration)	Configure the dependencies following the configuration
protected ClientSideElement.Script	_configureScript(Configuration configuration)	Configure the script
Map<String,Object>	add(String label, String description, String fireProcess, String cron, String schedulableId, Map<String,Object> params)	Schedule a task
protected Map<String,Object>	configureInitialParameters(Configuration configuration)	Configure the initial parameters
void	contextualize(Context context)
Map<String,List<String>>	getDependencies()	This method returns the list of dependencies, sorted by extension point.
List<Map<String,Object>>	getEvents(Long timestamp, List<String> categories)	Get event logs
Map<String,Object>	getParameters(String schedulableId)	Get the schedulable parameters
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureImports, _configureRights, _configureRightsMode, configure, getId, getPluginName, getRights, getScripts, getScripts, hasRight, setPluginInfo, toString

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, wait, wait, wait

Field Details

_context

protected Context _context

The Avalon context

_scheduler

protected Scheduler _scheduler

The Ametys scheduler

_logManager

protected LogManager _logManager

The log manager

Constructor Details

AddTaskClientSideElement

public AddTaskClientSideElement()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

getEvents

public List<Map<String,Object>> getEvents(Long timestamp,
 List<String> categories)

Get event logs

Parameters:

timestamp - Events after this timestamp will be retrieved

categories - Events will be filtered by these categories. If empty, all categories configured by the client side are accepted.

Returns:

the target types

_configureClass

protected String _configureClass(Configuration configuration)
                          throws ConfigurationException

Description copied from class: StaticClientSideElement

Configure the js class name

Overrides:

_configureClass in class StaticClientSideElement

Parameters:

configuration - The configuration on action tag

Returns:

The js class name

Throws:

ConfigurationException - If an error occurs

configureInitialParameters

protected Map<String,Object> configureInitialParameters(Configuration configuration)
                                                 throws ConfigurationException

Description copied from class: StaticClientSideElement

Configure the initial parameters

Overrides:

configureInitialParameters in class StaticClientSideElement

Parameters:

configuration - the global configuration

Returns:

The initial parameters read

Throws:

ConfigurationException - The configuration is incorrect

_configureScript

protected ClientSideElement.Script _configureScript(Configuration configuration)
                                             throws ConfigurationException

Description copied from class: StaticFileImportsClientSideElement

Configure the script

Overrides:

_configureScript in class StaticClientSideElement

Parameters:

configuration - the global configuration

Returns:

The script created

Throws:

ConfigurationException - The configuration is incorrect

_configureDependencies

protected Map<String,List<String>> _configureDependencies(Configuration configuration)
                                                   throws ConfigurationException

Description copied from class: StaticFileImportsClientSideElement

Configure the dependencies following the configuration

Overrides:

_configureDependencies in class StaticFileImportsClientSideElement

Parameters:

configuration - The root configuration

Returns:

The list of dependencies, by extension point.

Throws:

ConfigurationException - if a dependency element is present but empty

getDependencies

public Map<String,List<String>> getDependencies()

Description copied from interface: ClientSideElement

This method returns the list of dependencies, sorted by extension point.

Specified by:

getDependencies in interface ClientSideElement

Overrides:

getDependencies in class StaticFileImportsClientSideElement

Returns:

a map of dependencies ids by extension point.

add

public Map<String,Object> add(String label,
 String description,
 String fireProcess,
 String cron,
 String schedulableId,
 Map<String,Object> params)
                       throws SchedulerException

Schedule a task

Parameters:

label - the task label

description - the task description

fireProcess - the fire process

cron - the cron

schedulableId - the id of the schedulable

params - the schedulable parameters

Returns:

a json

Throws:

SchedulerException - if an error occurs when scheduling the task

getParameters

public Map<String,Object> getParameters(String schedulableId)
                                 throws Exception

Get the schedulable parameters

Parameters:

schedulableId - the id of the schedulable

Returns:

the parameters as json

Throws:

Exception - if an error occurs