com.canto.cumulus.prefs

Class SchedulerJobConfiguration

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.SchedulerJobConfiguration

public class SchedulerJobConfiguration
extends BaseManager

This class manages the configuration of a single scheduler job.

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields

Modifier and Type	Field and Description
static int	TIME_SPECIFICATION_MODE_OPTION_CRON
static int	TIME_SPECIFICATION_MODE_OPTION_SIMPLE

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
CatalogList	getCatalogList() Returns the list of catalogs that the job should work on.
java.lang.String	getCronText() Returns the current CRON mode configuration string.
java.lang.String	getInstance() Returns the server instance name.
JPack	getModulePreferences(PackListener listener) Returns the configuration pack for the module.
GUID	getModuleUID() Returns the module UID for the module being executed when this job starts.
boolean	getSendNotificationOnError() Returns whether the scheduler should send a notification message when an error occurred while executing this job.
boolean	getSendNotificationOnSuccessfulRun() Returns whether the scheduler should send a notification message when this job was executed successfully.
int	getSimpleSpecDaysOfWeek() Returns an int representing the days the job should run.
java.util.Date	getStartDate() Returns the start date for this job.
int	getTimeSpecificationMode() Returns the mode this scheduler job uses for determining the next start date.
boolean	isActive() Returns whether this scheduler job is active.
boolean	isAllCatalogs() Deprecated. Cumulus 8.1 no longer supports the "All Catalogs" option therefore this now always returns false.
boolean	isNewStart() Returns true if this job should be started immediately after being scheduled by the server ignoring the currently stored start date.
boolean	sameConfiguration(SchedulerJobConfiguration jobConfiguration) Returns whether the given jobs configuration equals this jobs configuration.
void	setActive(boolean active) Sets whether this scheduler job should be active.
void	setAllCatalogs(boolean all) Deprecated. Cumulus 8.1 no longer supports the "All Catalogs" option and this is now a no-op.
void	setCronText(java.lang.String text) Sets a new CRON mode configuration string.
void	setInstance(java.lang.String instance) Sets the server instance name.
void	setModulePreferences(PackListener listener, JPack pack) Sets the modules preferences.
void	setModuleUID(GUID uid) Sets the module UID of the module being executed at the scheduler server when this job runs.
void	setNewStart(boolean start) Configures whether this job should be started immediately after being scheduled by the server ignoring the currently stored start date.
void	setSendNotificationOnError(boolean sendNotification) Configures whether the scheduler should send a notification message when an error occurred while executing this job.
void	setSendNotificationOnSuccessfulRun(boolean sendNotification) Configures whether the scheduler should send a notification message when this job was executed successfully.
void	setSimpleSpecDaysOfWeek(int val) Sets the days the job should run.
void	setStartDate(java.util.Date date) Sets the start date this job should run the first time.
void	setTimeSpecificationMode(int mode) Sets the mode this scheduler job uses for determining the next start date.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TIME_SPECIFICATION_MODE_OPTION_SIMPLE

public static final int TIME_SPECIFICATION_MODE_OPTION_SIMPLE

See Also:

Constant Field Values

TIME_SPECIFICATION_MODE_OPTION_CRON

public static final int TIME_SPECIFICATION_MODE_OPTION_CRON

See Also:

Constant Field Values

Method Detail

isAllCatalogs

@Deprecated
public boolean isAllCatalogs()

Deprecated. Cumulus 8.1 no longer supports the "All Catalogs" option therefore this now always returns false.

Returns whether the job should work on all catalogs available at the server (ignoring the $Users catalog).

Returns:

always false as this method is now deprecated

setAllCatalogs

@Deprecated
public void setAllCatalogs(boolean all)

Deprecated. Cumulus 8.1 no longer supports the "All Catalogs" option and this is now a no-op.

Configures whether the job should work on all catalogs available at the server (ignoring the $Users catalog).

Parameters:

all - set to true if the job should work on all catalogs

isActive

public boolean isActive()

Returns whether this scheduler job is active.

Returns:

true if this job is active

setActive

public void setActive(boolean active)

Sets whether this scheduler job should be active.

Parameters:

active - set to true if this job is active

isNewStart

public boolean isNewStart()

Returns true if this job should be started immediately after being scheduled by the server ignoring the currently stored start date.

Returns:

true if this job should start immediately

setNewStart

public void setNewStart(boolean start)

Configures whether this job should be started immediately after being scheduled by the server ignoring the currently stored start date.

Parameters:

start - specify true to make this job start immediately

getTimeSpecificationMode

public int getTimeSpecificationMode()

Returns the mode this scheduler job uses for determining the next start date. The possible values are TIME_SPECIFICATION_MODE_OPTION_SIMPLE and TIME_SPECIFICATION_MODE_OPTION_CRON. Defaults to TIME_SPECIFICATION_MODE_OPTION_SIMPLE.

Returns:

mode this scheduler job uses for determining the next start date

setTimeSpecificationMode

public void setTimeSpecificationMode(int mode)

Sets the mode this scheduler job uses for determining the next start date. The possible values are TIME_SPECIFICATION_MODE_OPTION_SIMPLE and TIME_SPECIFICATION_MODE_OPTION_CRON.

Parameters:

mode - mode this scheduler job uses for determining the next start date

getCronText

public java.lang.String getCronText()

Returns the current CRON mode configuration string.

Returns:

string for the current CRON configuration

setCronText

public void setCronText(java.lang.String text)

Sets a new CRON mode configuration string. The string is not validated, therefore invalid values will made this job unusable.

Parameters:

text - new CRON configuration

getInstance

public java.lang.String getInstance()

Returns the server instance name.

Returns:

string the server instance name

Since:

11.1.5

setInstance

public void setInstance(java.lang.String instance)

Sets the server instance name.

Parameters:

instance - the server instance name

Since:

11.1.5

getCatalogList

public CatalogList getCatalogList()

Returns the list of catalogs that the job should work on.

Returns:

list of catalogs to work on

getSimpleSpecDaysOfWeek

public int getSimpleSpecDaysOfWeek()

Returns an int representing the days the job should run. The days are encoded in the following way: Bit 0=Sunday, Bit 1=Monday,...,Bit 7=Saturday.

Returns:

the days the job should run

setSimpleSpecDaysOfWeek

public void setSimpleSpecDaysOfWeek(int val)

Sets the days the job should run. The days are encoded into the int in the following way: Bit 0=Sunday, Bit 1=Monday,...,Bit 7=Saturday.

Parameters:

val - the days the job should run

getStartDate

public java.util.Date getStartDate()

Returns the start date for this job.

Returns:

date this job run for the first time.

setStartDate

public void setStartDate(java.util.Date date)

Sets the start date this job should run the first time.

Parameters:

date - the date to start this job

getSendNotificationOnSuccessfulRun

public boolean getSendNotificationOnSuccessfulRun()

Returns whether the scheduler should send a notification message when this job was executed successfully.

Returns:

true if the scheduler should send a notification message when this job was executed successfully

Since:

8.1

setSendNotificationOnSuccessfulRun

public void setSendNotificationOnSuccessfulRun(boolean sendNotification)

Configures whether the scheduler should send a notification message when this job was executed successfully.

Parameters:

sendNotification - true if the scheduler should send a notification message when this job was executed successfully, false otherwise

Since:

8.1

getSendNotificationOnError

public boolean getSendNotificationOnError()

Returns whether the scheduler should send a notification message when an error occurred while executing this job.

Returns:

true if the scheduler should send a notification message when an error occurred while executing this job

Since:

8.1

setSendNotificationOnError

public void setSendNotificationOnError(boolean sendNotification)

Configures whether the scheduler should send a notification message when an error occurred while executing this job.

Parameters:

sendNotification - true if the scheduler should send a notification message when an error occurred while executing this job, false otherwise

Since:

8.1

setModuleUID

public void setModuleUID(GUID uid)

Sets the module UID of the module being executed at the scheduler server when this job runs.

Parameters:

uid - module UID

getModuleUID

public GUID getModuleUID()

Returns the module UID for the module being executed when this job starts.

Returns:

module UID

getModulePreferences

public JPack getModulePreferences(PackListener listener)

Returns the configuration pack for the module.

Parameters:

listener - the listener being notified if the configuration should be saved

Returns:

the pack representing the modules preferences

setModulePreferences

public void setModulePreferences(PackListener listener,
                        JPack pack)

Sets the modules preferences.

Parameters:

listener - listener instance registered for changes when calling getModulePreferences(PackListener)

pack - the preferences to store

sameConfiguration

public boolean sameConfiguration(SchedulerJobConfiguration jobConfiguration)

Returns whether the given jobs configuration equals this jobs configuration.

Parameters:

jobConfiguration - the configuration to check for equality

Returns:

true if both configurations are identical