com.canto.cumulus.server.esp.modules.scheduler

Interface SchedulerConfigurator

public interface SchedulerConfigurator

Implementations of this interface are instantiated by the Server Console Scheduler Manager plugin.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_CUMULUS_CONFIGURED_CATALOGS
static java.lang.String	PARAM_CUMULUS_SERVER
static java.lang.String	PARAM_CUMULUS_SESSION

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configurationIsValid() Should return whether the current configuration state is valid.
void	finishConfiguration(boolean keepChanges) Specified whether the user closed the configuration dialog for you scheduler job using OK or Cancel.
javax.swing.JPanel	getConfigurationPanel() Returns the panel for configuring this scheduler job.
boolean	hasConfigurationPanel() Returns whether this scheduler job supports configuration at all.
void	setData(JPack data, java.util.Map additionalParams) Initializes the implementation with the given configuration pack.

Field Detail

PARAM_CUMULUS_SESSION

static final java.lang.String PARAM_CUMULUS_SESSION

See Also:

Constant Field Values

PARAM_CUMULUS_SERVER

static final java.lang.String PARAM_CUMULUS_SERVER

See Also:

Constant Field Values

PARAM_CUMULUS_CONFIGURED_CATALOGS

static final java.lang.String PARAM_CUMULUS_CONFIGURED_CATALOGS

See Also:

Constant Field Values

Method Detail

setData

void setData(JPack data,
           java.util.Map additionalParams)

Initializes the implementation with the given configuration pack. The additional params pack allows the configuration instance to access the current CumulusSession when using the map key PARAM_CUMULUS_SESSION.

Parameters:

data - configuration data pack

additionalParams - additional params

hasConfigurationPanel

boolean hasConfigurationPanel()

Returns whether this scheduler job supports configuration at all.

Returns:

true if this scheduler job supports configuration at all

getConfigurationPanel

javax.swing.JPanel getConfigurationPanel()

Returns the panel for configuring this scheduler job.

Returns:

the configuration panel for this job

configurationIsValid

boolean configurationIsValid()

Should return whether the current configuration state is valid. Currently not used, return always true.

Returns:

always true

finishConfiguration

void finishConfiguration(boolean keepChanges)

Specified whether the user closed the configuration dialog for you scheduler job using OK or Cancel. You only need to store the changes back into the pack from setData(com.canto.cumulus.utils.JPack,java.util.Map) if keepChanges is true.

Parameters:

keepChanges - true if user clicked OK, otherwise false.