com.inet.report.schedule
Class Scheduler.CustomActionDefinition

java.lang.Object
  com.inet.report.schedule.Scheduler.CustomActionDefinition

Enclosing class:

Scheduler

public static class Scheduler.CustomActionDefinition
extends java.lang.Object

This class stores information about a custom action. Each custom action registered in the i-net Scheduler is available for all tasks. So a custom action will have a unique name within the scheduler which does not need to be the class name.
The information this class holds are the following:

• name: the unique name for the custom action within the i-net Scheduler
• classname: the name of the class which is registered as custom action (has to be a sub class of ScheduleAction
• path: the path of the jar file where the custom action class can be found

Method Summary

java.lang.String	getClassName() This will return the name of the custom action class.
java.lang.String	getName() This will return the name of this custom action definition.
java.lang.String	getPath() Returns the path where the custom action class should be found.
void	setClassAndPath(java.lang.String className, java.lang.String path) This method will set the name of the custom action which should be represented by this custom action definition and the path where this custom action class should be found.
void	setName(java.lang.String name) Sets the name for the custom action which is represented by this custom action definition.

Method Detail

getClassName

public java.lang.String getClassName()

This will return the name of the custom action class.

Returns:

The name of the custom action class.

setClassAndPath

public void setClassAndPath(java.lang.String className,
                            java.lang.String path)
                     throws ScheduleException

This method will set the name of the custom action which should be represented by this custom action definition and the path where this custom action class should be found.

Parameters:

className - The name of the custom action class

path - The path of the jar file where the class can be found or empty if you're sure that the class in classpath when the scheduler is started.

Throws:

ScheduleException -

• If the class name of the custom action class was null or empty. (SE0014)
• If the custom action class could not be found in classpath. (SE0015)
• If the found custom action class is no sub class of ScheduleAction. (SE0016)
• If the found custom action class is abstract. (SE0017)

getName

public java.lang.String getName()

This will return the name of this custom action definition. Each custom action is registered with an unique name in the i-net Scheduler. This name is interpreted as a displayname and so does not need to be the name of the class. Of course you can feel free to name it like the class.

Returns:

The name of this custom action definition.

setName

public void setName(java.lang.String name)
             throws ScheduleException

Sets the name for the custom action which is represented by this custom action definition.

Parameters:

name - A unique name for the custom action. (Can also be the class name if you like it)

Throws:

ScheduleException -

• If the name for the custom action class was null or empty. (SE0018)
• If there is already a custom action defined with this name. (SE0019)

getPath

public java.lang.String getPath()

Returns the path where the custom action class should be found. Usually this will point to a jar file which will be added to the class path automatically to find the custom action class. This path can also be empty or null if you're sure that the custom action class is in class path when the i-net Scheduler is started.

Returns:

The path where the custom action class can be found. (Can be empty or null)