A B C D E F G H I J L M N O P Q R S T U V W Y 
All Classes All Packages

A

AbstractDefinition<T extends AbstractDefinition<T>> - Class in com.inet.taskplanner.server.api.common
A definition is a POJO describing a component used by TaskPlanner, see subclasses for details.
AbstractDefinition(String) - Constructor for class com.inet.taskplanner.server.api.common.AbstractDefinition
Creates a new Definition instance.
AbstractDefinition(String, Map<String, String>) - Constructor for class com.inet.taskplanner.server.api.common.AbstractDefinition
Creates a new Definition instance.
AbstractFactory<COMPONENT,​DEFINITION extends AbstractDefinition<DEFINITION>,​INFO extends AbstractInfo,​SUMMARY extends SummaryInfo> - Class in com.inet.taskplanner.server.api.common
Base class for all factories producing components for the TaskPlanner.
AbstractFactory(String) - Constructor for class com.inet.taskplanner.server.api.common.AbstractFactory
Creates a new Factory instance.
AbstractInfo - Class in com.inet.taskplanner.server.api.common
POJO containing information about a dynamic component in the TaskPlanner.
AbstractInfo(String, String, String, URL, String) - Constructor for class com.inet.taskplanner.server.api.common.AbstractInfo
Creates a new AbstractInfo instance only with required fields.
AbstractInfo(String, String, String, URL, String, List<Field>) - Constructor for class com.inet.taskplanner.server.api.common.AbstractInfo
Creates a new info instance.
activate(GUID, Trigger.TriggerAction) - Method in interface com.inet.taskplanner.server.api.trigger.Trigger
Activates this trigger.
activate(Trigger.TriggerAction) - Method in interface com.inet.taskplanner.server.api.trigger.Trigger
Deprecated.
ACTIVATED - com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
 
activateTask(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Activate the task with given ID.
ADDED - com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
 
addJob(JobDefinition) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Adds a job to this task by its definition.
addResultAction(ResultActionDefinition) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Adds a result action to this task by its definition.
addTask(TaskDefinition, GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Add a new task to the TaskPlanner.
addTimeZoneDifferenceHintIfRequired(ArrayList<Field>) - Static method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
FOR INTERNAL USE ONLY.
addTrigger(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Adds a trigger to this task by its definition.
ALL_CONDITIONS_ARE_FULFILLED - com.inet.taskplanner.server.api.action.ExecutionQualification
 
ALWAYS - com.inet.taskplanner.server.api.action.ExecutionQualification
 
areResultsProcessable() - Method in class com.inet.taskplanner.server.api.job.JobResultContainer
If the results of this contains are to be processed or not.
AT_LEAST_ONE_CONDITION_IS_FULFILLED - com.inet.taskplanner.server.api.action.ExecutionQualification
 

B

BOOLEAN - com.inet.taskplanner.server.api.field.FieldType
A checkbox that allows the values 'true' and 'false' (as String)
BooleanField - Class in com.inet.taskplanner.server.api.field
A field that allows a boolean state to be displayed as a checkbox.
BooleanField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.BooleanField
Creates the field for setting a true or false value
BooleanField(String, String, String) - Constructor for class com.inet.taskplanner.server.api.field.BooleanField
Creates the field for setting a true or false value
ByteArrayFileResult - Class in com.inet.taskplanner.server.api.result
A result that is based on in memory byte array.
ByteArrayFileResult(String, byte[]) - Constructor for class com.inet.taskplanner.server.api.result.ByteArrayFileResult
Create a new instance.

C

calculateNextExecutionTime(ZonedDateTime) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
cancelTask(GUID, boolean) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Cancel a currently executing task.
cancelTaskExecution(GUID, GUID, boolean) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Cancel a currently executing task's execution.
CannotSendEmail - com.inet.taskplanner.server.api.error.TaskPlannerCodes
 
checkDefinitionArgument(DEFINITION) - Method in class com.inet.taskplanner.server.api.common.AbstractFactory
Check if the given definition is not null and belongs to this factory.
cleanup() - Method in class com.inet.taskplanner.server.api.job.JobResultContainer
When result-handling is finished, then this method is called to clean up used system resources, i.e.
cleanup() - Method in class com.inet.taskplanner.server.api.job.ResultContainer
When result-handling is finished, then this method is called to clean up used system resources, i.e.
cleanup() - Method in class com.inet.taskplanner.server.api.result.ByteArrayFileResult
When result-handling is finished, then this method is called to clean up used system resources, i.e.
cleanup() - Method in class com.inet.taskplanner.server.api.result.LocalFileResult
When result-handling is finished, then this method is called to clean up used system resources, i.e.
cleanup() - Method in interface com.inet.taskplanner.server.api.result.Result
When result-handling is finished, then this method is called to clean up used system resources, i.e.
cleanup() - Method in class com.inet.taskplanner.server.api.result.StringTextResult
When result-handling is finished, then this method is called to clean up used system resources, i.e.
cleanUp(boolean) - Method in interface com.inet.taskplanner.server.api.series.Series
Perform some cleanup.
clearState() - Method in interface com.inet.taskplanner.server.api.trigger.Trigger
clears any persisted state of this trigger because the trigger has been significantly changed or manually deactivated The default implementation will do nothing but special implementations may exist.
COLOR - com.inet.taskplanner.server.api.field.FieldType
A color field
ColorField - Class in com.inet.taskplanner.server.api.field
A color field to pick a color from a chooser.
ColorField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.ColorField
Creates the field for setting a color
com.inet.taskplanner.server.api - package com.inet.taskplanner.server.api
 
com.inet.taskplanner.server.api.action - package com.inet.taskplanner.server.api.action
 
com.inet.taskplanner.server.api.action.email - package com.inet.taskplanner.server.api.action.email
 
com.inet.taskplanner.server.api.common - package com.inet.taskplanner.server.api.common
 
com.inet.taskplanner.server.api.error - package com.inet.taskplanner.server.api.error
 
com.inet.taskplanner.server.api.event - package com.inet.taskplanner.server.api.event
 
com.inet.taskplanner.server.api.field - package com.inet.taskplanner.server.api.field
 
com.inet.taskplanner.server.api.history - package com.inet.taskplanner.server.api.history
 
com.inet.taskplanner.server.api.job - package com.inet.taskplanner.server.api.job
 
com.inet.taskplanner.server.api.result - package com.inet.taskplanner.server.api.result
 
com.inet.taskplanner.server.api.series - package com.inet.taskplanner.server.api.series
 
com.inet.taskplanner.server.api.series.db - package com.inet.taskplanner.server.api.series.db
 
com.inet.taskplanner.server.api.series.folder - package com.inet.taskplanner.server.api.series.folder
 
com.inet.taskplanner.server.api.series.json - package com.inet.taskplanner.server.api.series.json
 
com.inet.taskplanner.server.api.template - package com.inet.taskplanner.server.api.template
 
com.inet.taskplanner.server.api.trigger - package com.inet.taskplanner.server.api.trigger
 
com.inet.taskplanner.server.api.trigger.cron - package com.inet.taskplanner.server.api.trigger.cron
 
com.inet.taskplanner.server.api.trigger.filechange - package com.inet.taskplanner.server.api.trigger.filechange
 
com.inet.taskplanner.server.api.trigger.lowmemory - package com.inet.taskplanner.server.api.trigger.lowmemory
 
com.inet.taskplanner.server.api.trigger.serverstart - package com.inet.taskplanner.server.api.trigger.serverstart
 
com.inet.taskplanner.server.api.trigger.serverstop - package com.inet.taskplanner.server.api.trigger.serverstop
 
com.inet.taskplanner.server.api.trigger.time - package com.inet.taskplanner.server.api.trigger.time
 
ConditionDefinition - Class in com.inet.taskplanner.server.api.job
Represents a condition for a job which decides whether the result of the job must be processed by resultActions or not.
ConditionDefinition() - Constructor for class com.inet.taskplanner.server.api.job.ConditionDefinition
Creates a new ConditionDefinition instance.
ConditionDefinition(Map<String, String>) - Constructor for class com.inet.taskplanner.server.api.job.ConditionDefinition
Creates a new ConditionDefinition instance.
ConditionInfo - Class in com.inet.taskplanner.server.api.job
Contains information about condition fields which the corresponding job offers.
ConditionInfo(List<Field>) - Constructor for class com.inet.taskplanner.server.api.job.ConditionInfo
Creates a new ConditionInfo instance.
copyDefinition() - Method in class com.inet.taskplanner.server.api.action.ResultActionDefinition
Makes a deep copy of this definition.
copyDefinition() - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
Makes a deep copy of this definition.
copyDefinition() - Method in class com.inet.taskplanner.server.api.job.ConditionDefinition
Makes a deep copy of this condition definition.
copyDefinition() - Method in class com.inet.taskplanner.server.api.job.JobDefinition
Makes a deep copy of this definition.
copyDefinition() - Method in class com.inet.taskplanner.server.api.series.SeriesDefinition
Makes a deep copy of this definition.
copyDefinition() - Method in class com.inet.taskplanner.server.api.trigger.TriggerDefinition
Makes a deep copy of this definition.
copyDefinitions(List<T>) - Static method in class com.inet.taskplanner.server.api.common.AbstractDefinition
Returns new list containing copies of the specified definitions which will be created using method copyDefinition().
copyTaskModel() - Method in class com.inet.taskplanner.server.api.TaskDefinition
Create a deep copy of this model.
create() - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder
Finish construction of the EmailResultAction and construct a definition object which can be added to a task.
create() - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder
Finish construction of the FileSystem ResultAction and construct a definition object which can be added to a task.
create() - Method in class com.inet.taskplanner.server.api.series.DbSeriesBuilder
Finish building and create a series definition.
create() - Static method in class com.inet.taskplanner.server.api.trigger.ServerStartTriggerBuilder
Create a new definition for a trigger which starts the task when the server is started.
create() - Method in class com.inet.taskplanner.server.api.trigger.TimeTriggerBuilder
Finish the configuration of the time trigger and create a TriggerDefinition which can be added to tasks.
create(GUID) - Static method in class com.inet.taskplanner.server.api.action.NextTaskActionBuilder
Construct a definition object for a new NextTaskResultAction.
create(String) - Static method in class com.inet.taskplanner.server.api.action.PrintResultActionBuilder
Creates a new ResultActionDefinition for a Print ResultAction using the given printer.
create(String) - Static method in class com.inet.taskplanner.server.api.result.ResultFlavor
Creates, registers and returns a new ResultFlavor type.
create(String) - Static method in class com.inet.taskplanner.server.api.trigger.CronTriggerBuilder
Create a new Definition for a CronTrigger using given cron expression.
create(String, ResultFlavor.FlavorLabel) - Static method in class com.inet.taskplanner.server.api.result.ResultFlavor
Creates, registers and returns a new ResultFlavor type.
createForFile(String) - Static method in class com.inet.taskplanner.server.api.trigger.FileChangeTriggerBuilder
Create a new Definition for a file change Trigger using given path string.
createForFile(Path) - Static method in class com.inet.taskplanner.server.api.trigger.FileChangeTriggerBuilder
Create a new Definition for a file change Trigger using given path.
createForFolder(String) - Static method in class com.inet.taskplanner.server.api.trigger.FileChangeTriggerBuilder
Create a new Definition for a file change Trigger using given path string.
createForFolder(Path) - Static method in class com.inet.taskplanner.server.api.trigger.FileChangeTriggerBuilder
Create a new Definition for a file change Trigger using given path.
createFrom(DEFINITION, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesIndependentFactory
Creates a concrete object to be used by TaskPlanner from given definition.
createFrom(DEFINITION, Map<String, String>, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory
Creates a concrete object to be used by TaskPlanner from given definition.
See SeriesDependentFactory.validate(AbstractDefinition, SeriesDefinition, GUID) for what is patched and replaced.
createInstanceFrom(ResultActionDefinition, GUID) - Method in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.series.json.JsonSeriesFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTriggerFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTriggerFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Construct a component (PRODUCT) from the given definition.
createInstanceFrom(DEFINITION) - Method in class com.inet.taskplanner.server.api.common.AbstractFactory
Deprecated. 
createInstanceFrom(DEFINITION, GUID) - Method in class com.inet.taskplanner.server.api.common.AbstractFactory
Construct a component (PRODUCT) from the given definition.
CronTriggerBuilder - Class in com.inet.taskplanner.server.api.trigger
Use this to construct a TriggerDefinition for a cron Trigger.
CronTriggerBuilder() - Constructor for class com.inet.taskplanner.server.api.trigger.CronTriggerBuilder
 
CronTriggerFactory - Class in com.inet.taskplanner.server.api.trigger.cron
Factory which produces CronTrigger components.
CronTriggerFactory() - Constructor for class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
Creates a new nice CronTriggerFactory instance.
CUSTOM - com.inet.taskplanner.server.api.trigger.time.RepeatInterval
Daily, weekly or monthly with custom interval.
CUSTOM_MONTHLY_DAY_DAY - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
On the [cardinality] day
CUSTOM_MONTHLY_DAY_WEEKDAY - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
On the [cardinality] weekday (Mo-Fr)

D

DAILY - com.inet.taskplanner.server.api.trigger.time.RepeatInterval
The task will be triggered on each day.
DataEntry - Class in com.inet.taskplanner.server.api
Defines an entry of requested data like priorities
DataEntry(String, String, String, int) - Constructor for class com.inet.taskplanner.server.api.DataEntry
Creates the entry with all necessary fields
DATASOURCE - Static variable in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
The name of a datasource used to create a SeriesDefinition.
DATE - com.inet.taskplanner.server.api.field.FieldType
A date selection field.
DateField - Class in com.inet.taskplanner.server.api.field
A field that allows the definition of a date value.
DateField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.DateField
Creates the field for setting a date
DbSeriesBuilder - Class in com.inet.taskplanner.server.api.series
Use this to easily create Series definitions which loads data from a database.
DbSeriesBuilder() - Constructor for class com.inet.taskplanner.server.api.series.DbSeriesBuilder
 
DbSeriesFactory - Class in com.inet.taskplanner.server.api.series.db
A series factory with data from a database.
DbSeriesFactory() - Constructor for class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
Create a new instance.
deactivate() - Method in interface com.inet.taskplanner.server.api.trigger.Trigger
Deactivates this trigger.
DEACTIVATED - com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
 
deactivateTask(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Deactivate the task with the given ID.
decodePassword(String) - Static method in class com.inet.taskplanner.server.api.field.PasswordField
Decodes the given encrypted password and returns the plain string
DisableCondition - Class in com.inet.taskplanner.server.api.field
A field condition that changes the accessability
DisableCondition(Field, FieldCondition.OP, String) - Constructor for class com.inet.taskplanner.server.api.field.DisableCondition
Creates the field condition
disabled - com.inet.taskplanner.server.api.field.FieldCondition.TYPE
The field is disabled
disabled(Field, FieldCondition.OP, String) - Static method in class com.inet.taskplanner.server.api.field.FieldCondition
Creates a disabled field condition.

E

EmailResultActionBuilder - Class in com.inet.taskplanner.server.api.action
Use this to easily create definitions for an Email ResultAction.
EmailResultActionBuilder(String, String, String...) - Constructor for class com.inet.taskplanner.server.api.action.EmailResultActionBuilder
Creates a new EmailResultBuilder with subject, message and receiver.
This will add file based results as attachments.
EmailResultActionFactory - Class in com.inet.taskplanner.server.api.action.email
A result action factory for managing the EmailResultAction settings and instances
EmailResultActionFactory() - Constructor for class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
Creates a instance of the factory.
encodePassword(String) - Static method in class com.inet.taskplanner.server.api.field.PasswordField
Encodes the given plain password with an internal strong encryption
equals - com.inet.taskplanner.server.api.field.FieldCondition.OP
The field value must be equal the given value
equals(Object) - Method in class com.inet.taskplanner.server.api.action.ResultActionDefinition
equals(Object) - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
equals(Object) - Method in class com.inet.taskplanner.server.api.event.TaskEvent
equals(Object) - Method in class com.inet.taskplanner.server.api.job.ConditionDefinition
equals(Object) - Method in class com.inet.taskplanner.server.api.job.JobDefinition
equals(Object) - Method in class com.inet.taskplanner.server.api.TaskDefinition
evaluateCondition(ConditionDefinition) - Method in class com.inet.taskplanner.server.api.job.Job
Evaluate the condition represented by given definition for this job.
execute(ProgressEventListener) - Method in class com.inet.taskplanner.server.api.job.Job
Execute this Job.
execute(Map<String, String>) - Method in interface com.inet.taskplanner.server.api.trigger.Trigger.TriggerAction
Start the task if possible.
executeAction(List<JobResultContainer>, ProgressEventListener) - Method in class com.inet.taskplanner.server.api.action.ResultAction
Performs the action for the given results.
executeTask(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Execute the task with given ID.
executeTask(TaskDefinition, GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Ad hoc execution of a custom task definition without the requirement to store the task first.
EXECUTION_ENDED - com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
Event with this type includes a executionID.
This event will come even if the task was deleted while executing.
EXECUTION_STARTED - com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
Event with this type includes a executionID.
ExecutionHistory - Interface in com.inet.taskplanner.server.api.history
Holds information about last executions of a TaskExecution.
ExecutionQualification - Enum in com.inet.taskplanner.server.api.action
Execution qualifications are used to determine whether actions should process job results.
EXTENSION - Static variable in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
The extension name used to create a SeriesDefinition.
EXTENSION_NAME - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
The extension name used to create a ResultActionDefinition.
EXTENSION_NAME - Static variable in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
Name of the Cron trigger to use as extension name in the TriggerDefinition
EXTENSION_NAME - Static variable in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Extension name of the file change trigger to use in triggerDefinitions.
EXTENSION_NAME - Static variable in class com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTriggerFactory
Name of the low memory trigger extension
EXTENSION_NAME - Static variable in class com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTriggerFactory
Name of the serverstart trigger extension
EXTENSION_NAME - Static variable in class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory
Name of the serverstop trigger extension
EXTENSION_NAME - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Extension name of the time trigger to use in triggerDefinitions.

F

Field - Class in com.inet.taskplanner.server.api.field
A field represents a component in the settings of a e.g.
Field(FieldType, String, String) - Constructor for class com.inet.taskplanner.server.api.field.Field
Creates the field instance
Field(FieldType, String, String, boolean) - Constructor for class com.inet.taskplanner.server.api.field.Field
Creates the field instance with the possibility to define whether the setting will be stored in the definition or not.
Field(String, String, String) - Constructor for class com.inet.taskplanner.server.api.field.Field
Creates the field instance
Field(String, String, String, boolean) - Constructor for class com.inet.taskplanner.server.api.field.Field
Creates the field instance with the possibility to define whether the setting will be stored in the definition or not.
FieldCondition - Class in com.inet.taskplanner.server.api.field
Defines a condition for a field, e.g.
FieldCondition(FieldCondition.TYPE) - Constructor for class com.inet.taskplanner.server.api.field.FieldCondition
Creates the field condition for the specified type
FieldCondition.OP - Enum in com.inet.taskplanner.server.api.field
The operation on the values to be applied
FieldCondition.TYPE - Enum in com.inet.taskplanner.server.api.field
The type of a field condition
FieldType - Enum in com.inet.taskplanner.server.api.field
Defines the type of field for the definition of e.g.
FILE - com.inet.taskplanner.server.api.field.FieldType
A file chooser that allows the selection of files.
FILE - Static variable in class com.inet.taskplanner.server.api.result.ResultFlavor
This flavor is used for any binary data with a known size.
FILE_OR_FOLDER - com.inet.taskplanner.server.api.field.FieldType
A file chooser that allows the selection of files or folders.
FileCannotBeWritten - com.inet.taskplanner.server.api.error.TaskPlannerCodes
 
FileChangeTriggerBuilder - Class in com.inet.taskplanner.server.api.trigger
Use this to construct a TriggerDefinition for a file change Trigger.
FileChangeTriggerBuilder() - Constructor for class com.inet.taskplanner.server.api.trigger.FileChangeTriggerBuilder
 
FileChangeTriggerFactory - Class in com.inet.taskplanner.server.api.trigger.filechange
A task planner trigger that executes a task when a file or folder changes.
FileChangeTriggerFactory() - Constructor for class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Creates instance of file change trigger factory.
FileField - Class in com.inet.taskplanner.server.api.field
A field that allows the definition of a file.
FileField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.FileField
Creates the field for choosing a file
FilenameField - Class in com.inet.taskplanner.server.api.field
A text field for filenames which will be later patched with ResultActionHelper.resolveFilenamePlaceholder.
FilenameField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.FilenameField
Creates the field for setting a text
FileOrFolderField - Class in com.inet.taskplanner.server.api.field
A field that allows the definition of a file or a folder.
FileOrFolderField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.FileOrFolderField
Creates the field for choosing a file
FileResult - Interface in com.inet.taskplanner.server.api.result
A file result is result type which has been produced by a Job and is processed by actions.
By convention, it always implies the flavor FILE.
Not all ResultAction can handle each FileResult, result flavors define the kind of information/data a FileResult represents and actions will handle only results they support.
FileSystemResultActionBuilder - Class in com.inet.taskplanner.server.api.action
Use this to easily create definitions for a FileSystem ResultAction.
FileSystemResultActionBuilder(File) - Constructor for class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder
Creates a new FileSystemResultActionBuilder with given destination directory.
FileSystemResultActionBuilder(String) - Constructor for class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder
Creates a new FileSystemResultActionBuilder with given destination directory.
FileSystemResultActionBuilder(Path) - Constructor for class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder
Creates a new FileSystemResultActionBuilder with given destination directory.
FILTER - Static variable in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory
Defines the file filter like *.pdf to filter the files that should be used in this series.
FIRST - com.inet.taskplanner.server.api.trigger.time.MonthlyDay
The first day of the month is used
FIX_NUMBER - com.inet.taskplanner.server.api.field.FieldType
An integer field
FLOAT_NUMBER - com.inet.taskplanner.server.api.field.FieldType
A float field
FloatField - Class in com.inet.taskplanner.server.api.field
A field that takes a float number as input.
FloatField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.FloatField
Construct the numeric field
FloatField(String, String, List<UnitConfigProperty.Unit>) - Constructor for class com.inet.taskplanner.server.api.field.FloatField
Construct the numeric field including a list of UnitConfigProperty.Unit to select between with automatic recalculation.
FOLDER - com.inet.taskplanner.server.api.field.FieldType
A file chooser that allows the selection of folder.
FOLDER - Static variable in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory
This property defines the path (or supported URI like "repo") to a folder.
FolderField - Class in com.inet.taskplanner.server.api.field
A field that allows the definition of folder.
FolderField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.FolderField
Creates the field for choosing a folder
FolderSeriesFactory - Class in com.inet.taskplanner.server.api.series.folder
A series factory for managing the FolderSeries settings and instances.
FolderSeriesFactory() - Constructor for class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory
Create a new instance.
FOURTH - com.inet.taskplanner.server.api.trigger.time.MonthlyDay
The fourth day of the month is used
fromRangeFieldValue(String) - Static method in class com.inet.taskplanner.server.api.field.RangeField
Convert a given string value into a RangeField.NumberRange The value should come from a RangeField

G

generateFilterableFieldList(Set<String>) - Method in interface com.inet.taskplanner.server.api.field.TaskFieldListGenerator
generates the task planner Field instances including a filter type drop down box, for the given filter types
generateNiceReadableSentenceForExecution(ZonedDateTime, String, TriggerDefinition) - Static method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
FOR INTERNAL USE ONLY.
GenericExecutionError - com.inet.taskplanner.server.api.error.TaskPlannerCodes
 
getAllAvailableProtocols() - Static method in class com.inet.taskplanner.server.api.field.FolderField
Returns a list of all registered protocols that can be used.
getAllTaskIDs() - Method in class com.inet.taskplanner.server.api.TaskPlanner
Get a list with the IDs of all Tasks of the TaskPlanner.
getCachedKeys() - Method in class com.inet.taskplanner.server.api.series.SeriesDefinition
Returns the set of keys from the factory that were cached.
getCardinalityFromSetting(ZonedDateTime, MonthlyDay) - Static method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
FOR INTERNAL USE ONLY.
getCondition() - Method in class com.inet.taskplanner.server.api.job.JobDefinition
Get the condition of this Job.
getConditionEntries() - Method in class com.inet.taskplanner.server.api.job.JobSummaryInfo
Returns the summary entries for the optional condition
getConditionInfo() - Method in class com.inet.taskplanner.server.api.job.JobInfo
Get information about the condition this job can have configured.
getConditions() - Method in class com.inet.taskplanner.server.api.field.Field
Returns the fields for the condition.
getDescription() - Method in class com.inet.taskplanner.server.api.common.AbstractInfo
Get the localized description of the component.
getDescription() - Method in class com.inet.taskplanner.server.api.TaskDefinition
Returns the description for this task.
getDescription(Locale) - Method in interface com.inet.taskplanner.server.api.template.TaskTemplateDefinition
returns the localized description of the template to display to the user
getDisplayName() - Method in class com.inet.taskplanner.server.api.common.AbstractInfo
Get the localized display name of the component.
getEntries() - Method in class com.inet.taskplanner.server.api.common.SummaryInfo
Returns the list of summary entries
getEntriesFor(String) - Method in interface com.inet.taskplanner.server.api.field.TaskFieldListGenerator
returns any known entries for the given field type constant/id
getEntriesFor(String, String, String) - Method in interface com.inet.taskplanner.server.api.field.TaskFieldListGenerator
returns any known entries for the given field type constant/id including filtering
getErrorCodeNumber() - Method in enum com.inet.taskplanner.server.api.error.TaskPlannerCodes
getErrors() - Method in exception com.inet.taskplanner.server.api.error.ValidationException
Returns the errors of this ValidationException
getErrors() - Method in interface com.inet.taskplanner.server.api.history.HistoryEntry
Returns the list of errors of this execution.
getExecutedSeriesCount() - Method in interface com.inet.taskplanner.server.api.history.HistoryEntry
Returns the number of series data sets that were executed in case the task has a series set.
getExecutionFinishTime() - Method in interface com.inet.taskplanner.server.api.history.HistoryEntry
Returns the executionFinishTime of this Execution in milliseconds since January 1, 1970, 00:00:00 GMT.
The value can be 0 if the execution is still running or -1 if the execution did not finish normally.
getExecutionHistory() - Method in interface com.inet.taskplanner.server.api.TaskExecution
Returns the executionHistory of this Task.
Those are information about past and possible current executions.
getExecutionId() - Method in interface com.inet.taskplanner.server.api.history.HistoryEntry
Get the ID uniquely identifying this execution.
getExecutionID() - Method in class com.inet.taskplanner.server.api.event.TaskEvent
Get the ID of the execution this event is about.
getExecutionQualification() - Method in class com.inet.taskplanner.server.api.action.ResultActionDefinition
Returns the executionQualification of this ResultActionDefinition
getExecutionStartTime() - Method in interface com.inet.taskplanner.server.api.history.HistoryEntry
Returns the time when execution was started in milliseconds since January 1, 1970, 00:00:00 GMT.
getExtensionName() - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
Get the unique extensionName of the component this definition represents.
getExtensionName() - Method in class com.inet.taskplanner.server.api.common.AbstractFactory
getExtensionName() - Method in class com.inet.taskplanner.server.api.common.AbstractInfo
Returns the extensionName for the component this info is describing.
getFields() - Method in class com.inet.taskplanner.server.api.common.AbstractInfo
Returns the list of fields that contains the property entries.
getFields() - Method in class com.inet.taskplanner.server.api.job.ConditionInfo
Get the List with fields which can be configured.
getFileContent() - Method in class com.inet.taskplanner.server.api.result.ByteArrayFileResult
Get a stream to access the data of this result.
getFileContent() - Method in interface com.inet.taskplanner.server.api.result.FileResult
Get a stream to access the data of this result.
getFileContent() - Method in class com.inet.taskplanner.server.api.result.LocalFileResult
Get a stream to access the data of this result.
getFileContentType() - Method in class com.inet.taskplanner.server.api.result.ByteArrayFileResult
Get the MIME type this result has.
getFileContentType() - Method in interface com.inet.taskplanner.server.api.result.FileResult
Get the MIME type this result has.
getFileContentType() - Method in class com.inet.taskplanner.server.api.result.LocalFileResult
Get the MIME type this result has.
getFileName() - Method in class com.inet.taskplanner.server.api.result.ByteArrayFileResult
Returns a human readable name of this result, typically a file name.
getFileName() - Method in interface com.inet.taskplanner.server.api.result.FileResult
Returns a human readable name of this result, typically a file name.
getFileName() - Method in class com.inet.taskplanner.server.api.result.LocalFileResult
Returns a human readable name of this result, typically a file name.
getFileSize() - Method in class com.inet.taskplanner.server.api.result.ByteArrayFileResult
Returns the size of this result in bytes.
getFileSize() - Method in interface com.inet.taskplanner.server.api.result.FileResult
Returns the size of this result in bytes.
getFileSize() - Method in class com.inet.taskplanner.server.api.result.LocalFileResult
Returns the size of this result in bytes.
getFirstValue() - Method in class com.inet.taskplanner.server.api.field.RangeField.NumberRange
Returns the lower bound value
getFirstValueFromSeries(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory
Get the first set of properties from the given series
getFlavors() - Method in class com.inet.taskplanner.server.api.job.JobResultContainer
Returns the flavors supported by this container
getFlavors() - Method in class com.inet.taskplanner.server.api.job.ResultContainer
Returns the flavors supported by this container
getFlavors() - Method in class com.inet.taskplanner.server.api.result.ByteArrayFileResult
Defined the types of data this Result contains.
getFlavors() - Method in interface com.inet.taskplanner.server.api.result.FileResult
Defined the types of data this Result contains.
getFlavors() - Method in class com.inet.taskplanner.server.api.result.LocalFileResult
Defined the types of data this Result contains.
getFlavors() - Method in interface com.inet.taskplanner.server.api.result.PrintResult
Defined the types of data this Result contains.
getFlavors() - Method in interface com.inet.taskplanner.server.api.result.Result
Defined the types of data this Result contains.
getFlavors() - Method in interface com.inet.taskplanner.server.api.result.TextResult
Defined the types of data this Result contains.
getHelpKey() - Method in class com.inet.taskplanner.server.api.common.AbstractInfo
Get the help-key of the page to open for the component.
getIconURL() - Method in class com.inet.taskplanner.server.api.common.AbstractInfo
Get the URL of the Icon for the component.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.common.AbstractFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.series.json.JsonSeriesFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTriggerFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTriggerFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory
Returns an information object about components which can be produced with this factory.
getInformation(GUID) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Returns an information object about components which can be produced with this factory.
getInstance() - Static method in class com.inet.taskplanner.server.api.TaskPlanner
Get the taskPlanner instance, creates one if none was created yet.
getJobs() - Method in class com.inet.taskplanner.server.api.TaskDefinition
Get the list of jobs configured in this task.
getKey() - Method in class com.inet.taskplanner.server.api.field.Field
Returns the key that is stored in the definition
getKey() - Method in class com.inet.taskplanner.server.api.result.ResultFlavor
Returns the key of this ResultFlavor
getKey() - Method in interface com.inet.taskplanner.server.api.template.TaskTemplateDefinition
unique key of the template
getKeys(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory
Get a set of keys that can be used in placeholder.
getKeys(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.SeriesFactory
Get a set of keys that can be used in placeholder.
getLabel() - Method in class com.inet.taskplanner.server.api.common.SummaryEntry
Returns the label of this SummaryInfo
getLabel() - Method in class com.inet.taskplanner.server.api.DataEntry
accessor method for the display label string of the entry
getLabel() - Method in class com.inet.taskplanner.server.api.field.Field
Returns the label to be should in front of the component
getLabel() - Method in class com.inet.taskplanner.server.api.result.ResultFlavor
Returns the localized label of this flavor
getLabel(String, Locale) - Method in interface com.inet.taskplanner.server.api.template.TaskTemplateDefinition
returns the localized label, based on the given locale.
getLastExecutions() - Method in interface com.inet.taskplanner.server.api.history.ExecutionHistory
Returns the lastExecutions.
getLastModified() - Method in interface com.inet.taskplanner.server.api.TaskExecution
Get the time in ms since January 1, 1970 00:00:00.000 GMT when this task has been changed the last time.
This only counts modifications of the settings, not manual or automatic executions.
getMetaProperties() - Method in class com.inet.taskplanner.server.api.job.JobResultContainer
Returns the additional meta properties for the job execution.
getMetaProperties() - Method in class com.inet.taskplanner.server.api.job.ResultContainer
Returns the additional meta properties for the job execution.
getName() - Method in class com.inet.taskplanner.server.api.TaskDefinition
Get the display name of this task.
getName(Locale) - Method in interface com.inet.taskplanner.server.api.template.TaskTemplateDefinition
returns the localized name of the template to display to the user
getNextExecutionDates(TriggerDefinition) - Static method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
FOR INTERNAL USE ONLY.
getNextExecutionsAsSummary(List<ZonedDateTime>) - Static method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
FOR INTERNAL USE ONLY.
getNextExecutionsForCronExpression(String) - Static method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
FOR INTERNAL USE ONLY.
getNextExecutionsForCronExpression(String, ZonedDateTime, Predicate<ZonedDateTime>) - Static method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
FOR INTERNAL USE ONLY.
getNextExecutionsSummaryText(List<ZonedDateTime>) - Static method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
FOR INTERNAL USE ONLY.
getNextExecutionTimes(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
Returns the calculated time of the next executions.
getNextExecutionTimes(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Returns the calculated time of the next executions.
getNextExecutionTimes(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.TriggerFactory
Returns the calculated time of the next executions.
getOwnerId() - Method in interface com.inet.taskplanner.server.api.TaskExecution
get the ID of the user owning this task.
getPathOutOfDef(TriggerDefinition) - Static method in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Gets path out of trigger definition.
getPlaceholder() - Method in class com.inet.taskplanner.server.api.field.Field
Returns the placeholder text that is displayed if the field is left empty
getPlaceholderKeys() - Method in class com.inet.taskplanner.server.api.action.ResultActionInfo
Returns a list of placeholder key (without placeholder brackets)that are supported by this action.
getPlaceholderKeys() - Method in class com.inet.taskplanner.server.api.job.JobInfo
Returns a list of placeholder key (without placeholder brackets)that are supported by this action.
getPlaceholderKeys() - Method in class com.inet.taskplanner.server.api.trigger.TriggerInfo
Get a list of placeholder key (without placeholder brackets) that are supported by this action.
getProgress() - Method in class com.inet.taskplanner.server.api.event.TaskEvent
Returns the progress of the current task execution in case TaskEvent.getType() returns TaskEvent.TaskEventType.PROGRESS
getProgress() - Method in interface com.inet.taskplanner.server.api.history.HistoryEntry
Returns the progress of the task [0..100].
getProperties() - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
Get the properties object of this definition.
getProperties() - Method in class com.inet.taskplanner.server.api.job.ConditionDefinition
Get the properties object from this condition definition.
getProperty(String) - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
Searches for the property with the specified key in this property list.
getProperty(String) - Method in class com.inet.taskplanner.server.api.job.ConditionDefinition
Returns the value of a property of this definition
getResultActions() - Method in class com.inet.taskplanner.server.api.TaskDefinition
Get the list of result actions configured in this task.
getResultFlavors(JobDefinition) - Method in class com.inet.taskplanner.server.api.job.JobFactory
Returns the list of supported flavors.
getResults(ResultFlavor) - Method in class com.inet.taskplanner.server.api.job.JobResultContainer
Returns all results for a certain flavor
getResults(ResultFlavor) - Method in class com.inet.taskplanner.server.api.job.ResultContainer
Returns all results for a certain flavor
getSecondValue() - Method in class com.inet.taskplanner.server.api.field.RangeField.NumberRange
Returns the upper bound value
getSeries() - Method in class com.inet.taskplanner.server.api.TaskDefinition
Get the optional series of this task.
getSkippedResultActions() - Method in interface com.inet.taskplanner.server.api.history.HistoryEntry
Returns the list of ids of result action that where not executed due to not fulfilled conditions.
getStateProperties() - Method in interface com.inet.taskplanner.server.api.TaskExecution
returns a live (read-writeable) map of properties for this task's execution which enables task components to maintain state, e.g.
getSummary() - Method in class com.inet.taskplanner.server.api.action.ResultActionDefinition
Get a summary information with list of String-pars which summarizes the settings for this ResultAction in the webgui.
getSummary() - Method in class com.inet.taskplanner.server.api.trigger.TriggerDefinition
Get summary infos about this Trigger.
getSummary(ResultActionDefinition) - Method in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
Construct Summary infos for the component represented by given definition.
getSummary(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
Construct Summary infos for the component represented by given definition.
getSummary(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory
Construct Summary infos for the component represented by given definition.
getSummary(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.json.JsonSeriesFactory
Construct Summary infos for the component represented by given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
Construct Summary infos for the component represented by given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Construct Summary infos for the component represented by given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTriggerFactory
Construct Summary infos for the component represented by given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTriggerFactory
Construct Summary infos for the component represented by given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory
Construct Summary infos for the component represented by given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Construct Summary infos for the component represented by given definition.
getSummary(DEFINITION) - Method in class com.inet.taskplanner.server.api.common.AbstractFactory
Construct Summary infos for the component represented by given definition.
getSupportedFlavors(ResultActionDefinition) - Method in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
Returns the list of flavors, supported by this action for the given definition.
getSupportedFlavors(ResultActionDefinition) - Method in class com.inet.taskplanner.server.api.action.ResultActionFactory
Returns the list of flavors, supported by this action for the given definition.
getTaskDefinition() - Method in interface com.inet.taskplanner.server.api.template.TaskTemplateDefinition
returns the definition of the task to use for creation of a new task.
getTaskDefinition(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Retrieve the definition of and existing and stored task.
Note: The returned instance is a copy of the internal definition.
getTaskExecution(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Retrieve the execution data of an existing and stored task.
getTaskID() - Method in class com.inet.taskplanner.server.api.event.TaskEvent
Get the ID of the task this event is about.
getTaskID() - Method in interface com.inet.taskplanner.server.api.TaskExecution
Get the unique ID of this task.
getText() - Method in class com.inet.taskplanner.server.api.result.StringTextResult
Returns the content of the result in form of a String.
getText() - Method in interface com.inet.taskplanner.server.api.result.TextResult
Returns the content of the result in form of a String.
getTextContent() - Method in class com.inet.taskplanner.server.api.result.StringTextResult
Returns the content of the result in form of an InputStream with encoding StandardCharsets.UTF_8.
getTextContent() - Method in interface com.inet.taskplanner.server.api.result.TextResult
Returns the content of the result in form of an InputStream with encoding StandardCharsets.UTF_8.
getTextContentType() - Method in class com.inet.taskplanner.server.api.result.StringTextResult
Get the MIME type this result has.
getTextContentType() - Method in interface com.inet.taskplanner.server.api.result.TextResult
Get the MIME type this result has.
getTriggerDescribingStringForLog() - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
getTriggers() - Method in class com.inet.taskplanner.server.api.TaskDefinition
Get the list of triggers configured in this task.
getType() - Method in class com.inet.taskplanner.server.api.event.TaskEvent
Get the type of this event.
getType() - Method in class com.inet.taskplanner.server.api.field.Field
Returns the type of the field which defines how the field is displayed
getType() - Method in class com.inet.taskplanner.server.api.field.FieldCondition
Returns the type of the condition like e.g.
getUid() - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
Returns the unique identifier of this definition.
getUserTaskIDs(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Get a list with the IDs of all Tasks belonging to the current user.
getValue() - Method in class com.inet.taskplanner.server.api.common.SummaryEntry
Returns the value of this SummaryInfo
getValue() - Method in class com.inet.taskplanner.server.api.DataEntry
accessor method for the internal value (string key) of the entry
getValue() - Method in class com.inet.taskplanner.server.api.field.Field
Returns the current value of the field
getValues() - Method in class com.inet.taskplanner.server.api.field.SelectField
Returns the list of translated values
GROUP - com.inet.taskplanner.server.api.field.FieldType
A group name
GroupField - Class in com.inet.taskplanner.server.api.field
A field that adds a group between multiple properties
GroupField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.GroupField
Creates the field to display a label text

H

handle(List<JobResultContainer>) - Method in class com.inet.taskplanner.server.api.action.ResultAction
Handle the given results.
hashCode() - Method in class com.inet.taskplanner.server.api.action.ResultActionDefinition
hashCode() - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
hashCode() - Method in class com.inet.taskplanner.server.api.event.TaskEvent
hashCode() - Method in class com.inet.taskplanner.server.api.job.ConditionDefinition
hashCode() - Method in class com.inet.taskplanner.server.api.job.JobDefinition
hashCode() - Method in class com.inet.taskplanner.server.api.TaskDefinition
hasPlaceholderSet(String, GUID) - Method in class com.inet.taskplanner.server.api.action.ResultActionFactory
Returns whether the given value contains at least one of the available placeholders of the task.
HistoryEntry - Interface in com.inet.taskplanner.server.api.history
Holds information about one execution of a TaskExecution.
The execution may, but does not need to, be already finished.

I

INITIAL - com.inet.taskplanner.server.api.trigger.time.MonthlyDay
The day of month from the startDate is used
INTERVALTYPE_DAILY - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
Daily rhythm
INTERVALTYPE_MONTHLY - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
Monthly rhythm
INTERVALTYPE_WEEKLY - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
Weekly rhythm
isActivated() - Method in class com.inet.taskplanner.server.api.TaskDefinition
Returns whether this task is activated.
isAutoResolvePlaceholders() - Method in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
Defines whether placeholders will be automatically replaced before the handle method is called.
isAutoResolvePlaceholders() - Method in class com.inet.taskplanner.server.api.action.ResultActionFactory
Defines whether placeholders will be automatically replaced before the handle method is called.
isAvailable() - Method in class com.inet.taskplanner.server.api.common.AbstractFactory
Whether the (COMPONENT) is available or not.
isAvailable() - Method in class com.inet.taskplanner.server.api.series.json.JsonSeriesFactory
Whether the (COMPONENT) is available or not.
isAvailable() - Method in interface com.inet.taskplanner.server.api.template.TaskTemplateDefinition
whether this template is available and should be displayed
isAvailable() - Method in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Whether the (COMPONENT) is available or not.
isAvailable() - Method in class com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTriggerFactory
Whether the (COMPONENT) is available or not.
isAvailable() - Method in class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory
Whether the (COMPONENT) is available or not.
isRunning() - Method in interface com.inet.taskplanner.server.api.TaskExecution
Check if this task is currently running (one or more executions)
isUpdateValuesOnChange() - Method in class com.inet.taskplanner.server.api.field.Field
Returns whether the whole values of the fields in the current dialog should be updated if the value of the current field changes
isValidValue(String) - Static method in class com.inet.taskplanner.server.api.field.FloatField
Returns true, if the value is valid
isValidValue(String) - Static method in class com.inet.taskplanner.server.api.field.NumberField
Returns true, if the value is valid
isValueSavable() - Method in class com.inet.taskplanner.server.api.field.Field
Returns whether the value should be stored

J

JDBC_URL - Static variable in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
The JDBC url property used to create a SeriesDefinition.
Job - Class in com.inet.taskplanner.server.api.job
A Job is a bunch of work which produces a result.
Job(ConditionDefinition) - Constructor for class com.inet.taskplanner.server.api.job.Job
Creates a new Job instance.
JobDefinition - Class in com.inet.taskplanner.server.api.job
Definition of a job for a TaskDefinition with settings required for the job.
JobDefinition(String) - Constructor for class com.inet.taskplanner.server.api.job.JobDefinition
Creates a new JobDefinition instance.
JobDefinition(String, Map<String, String>) - Constructor for class com.inet.taskplanner.server.api.job.JobDefinition
Creates a new JobDefinition instance.
JobFactory<T extends Job> - Class in com.inet.taskplanner.server.api.job
Base class for factories producing Job components.
JobFactory(String) - Constructor for class com.inet.taskplanner.server.api.job.JobFactory
Creates a new JobFactory instance.
JobInfo - Class in com.inet.taskplanner.server.api.job
Contains information about how this kind of job is to be presented, what options with what type it has and how they interact with each other.
JobInfo(String, String, String, URL, String) - Constructor for class com.inet.taskplanner.server.api.job.JobInfo
Creates a new JobInfo instance with only required fields.
JobInfo(String, String, String, URL, String, ConditionInfo, List<Field>) - Constructor for class com.inet.taskplanner.server.api.job.JobInfo
Creates a new JobInfo instance with all optional fields.
JobInfo(String, String, String, URL, String, ConditionInfo, List<Field>, List<String>) - Constructor for class com.inet.taskplanner.server.api.job.JobInfo
Creates a new JobInfo instance with all optional fields.
JobInfo(String, String, String, URL, String, List<Field>) - Constructor for class com.inet.taskplanner.server.api.job.JobInfo
Creates a new JobInfo instance with fields.
JobInfo(String, String, String, URL, String, List<Field>, List<String>) - Constructor for class com.inet.taskplanner.server.api.job.JobInfo
Creates a new JobInfo instance with fields.
JobResultContainer - Class in com.inet.taskplanner.server.api.job
The result to be returned by a Job
JobResultContainer() - Constructor for class com.inet.taskplanner.server.api.job.JobResultContainer
 
JobSummaryInfo - Class in com.inet.taskplanner.server.api.job
A specialized summary information for jobs.
JobSummaryInfo(List<SummaryEntry>, List<SummaryEntry>) - Constructor for class com.inet.taskplanner.server.api.job.JobSummaryInfo
Create the summary information for a job
JsonSeriesFactory - Class in com.inet.taskplanner.server.api.series.json
A series factory for managing the JsonSeries settings and instances.
JsonSeriesFactory() - Constructor for class com.inet.taskplanner.server.api.series.json.JsonSeriesFactory
Create a new instance.

L

label() - Method in interface com.inet.taskplanner.server.api.result.ResultFlavor.FlavorLabel
Returns the localized label for the ResultFlavor.
LABEL - com.inet.taskplanner.server.api.field.FieldType
A plain label.
LabelField - Class in com.inet.taskplanner.server.api.field
A field that allows the definition of a single or multi line label.
LabelField(String, String, String) - Constructor for class com.inet.taskplanner.server.api.field.LabelField
Creates the field to display a label text
LAST - com.inet.taskplanner.server.api.trigger.time.MonthlyDay
The last day of the month is used.
LINK - com.inet.taskplanner.server.api.field.FieldType
A link with an URL and a target definition
LinkField - Class in com.inet.taskplanner.server.api.field
A field that allows the display of a link.
LinkField(String, String, String, String) - Constructor for class com.inet.taskplanner.server.api.field.LinkField
Creates the field to display a link
LocalFileResult - Class in com.inet.taskplanner.server.api.result
A result that is based on a file.
LocalFileResult(File, boolean) - Constructor for class com.inet.taskplanner.server.api.result.LocalFileResult
Create a new instance.
LowMemoryTriggerFactory - Class in com.inet.taskplanner.server.api.trigger.lowmemory
Factory for LowMemoryTrigger.
LowMemoryTriggerFactory() - Constructor for class com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTriggerFactory
Creates instance of low memory trigger factory.

M

MODIFIED - com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
If a modification includes the activation or deactivation of the task, then no extra ACTIVATED or DEACTIVATED events are sent.
MONTHLY - com.inet.taskplanner.server.api.trigger.time.RepeatInterval
The task will be triggered once a month.
MonthlyDay - Enum in com.inet.taskplanner.server.api.trigger.time
For a monthly repeat interval this determines the day of the month for the execution.
mustHandleResults(int, int) - Method in enum com.inet.taskplanner.server.api.action.ExecutionQualification
Determine whether an action with this Qualification must run based of number of executed jobs and number of executed jobs with fulfilled conditions.

N

needsLocalization(String) - Method in interface com.inet.taskplanner.server.api.template.TaskTemplateDefinition
whether this key needs localization (if not, getLabel will return the given key directly)
NextTaskActionBuilder - Class in com.inet.taskplanner.server.api.action
Use this to easily create definitions for a NextTaskResultAction.
NextTaskActionBuilder() - Constructor for class com.inet.taskplanner.server.api.action.NextTaskActionBuilder
 
NO_CONDITION_IS_FULFILLED - com.inet.taskplanner.server.api.action.ExecutionQualification
 
NONE - com.inet.taskplanner.server.api.trigger.time.RepeatInterval
No Repetition.
NONE - Static variable in class com.inet.taskplanner.server.api.result.ResultFlavor
This flavor can be used to trigger a ResultAction without passing any content data.
notequal - com.inet.taskplanner.server.api.field.FieldCondition.OP
The field value must NOT be equal the given value
notify(TaskEvent) - Method in interface com.inet.taskplanner.server.api.event.TaskEventListener
Called when a task was changed, executed or execution completed.
NotTaskOwner - com.inet.taskplanner.server.api.error.TaskPlannerCodes
 
NUMBER_RANGE - com.inet.taskplanner.server.api.field.FieldType
A fixed number range
NumberField - Class in com.inet.taskplanner.server.api.field
A field that takes an integer number as input The field supports place holders from the TaskPlanner, which has to be accounted for
NumberField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.NumberField
Construct the numeric field
NumberField(String, String, List<UnitConfigProperty.Unit>) - Constructor for class com.inet.taskplanner.server.api.field.NumberField
Construct the numeric field including a list of UnitConfigProperty.Unit to select between with automatic recalculation.

O

OldFilesCannotBeDeleted - com.inet.taskplanner.server.api.error.TaskPlannerCodes
 

P

PASSWORD - com.inet.taskplanner.server.api.field.FieldType
A password field
PASSWORD - Static variable in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
The password property used to create a SeriesDefinition.
PasswordField - Class in com.inet.taskplanner.server.api.field
A field that allows the definition of a password.
PasswordField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.PasswordField
Creates the field for setting a password
passwordFieldAsTextArea(String, String, String) - Static method in class com.inet.taskplanner.server.api.field.PasswordField
Creates the field for setting a password - as textarea, which displays the value only when being created
patchDefinitionProperties(JobDefinition, Map<String, String>, GUID) - Method in class com.inet.taskplanner.server.api.job.JobFactory
Patch the properties of the given baseDefinition with properties from the seriesProperties.
patchDefinitionProperties(DEFINITION, Map<String, String>, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory
Patch the properties of the given baseDefinition with properties from the seriesProperties.
patchResultPlaceholderInValue(String, List<JobResultContainer>) - Method in class com.inet.taskplanner.server.api.field.Field
Override to replace the placeholders with the values from the results
patchResultPlaceholderInValue(String, List<JobResultContainer>) - Method in class com.inet.taskplanner.server.api.field.FolderField
Override to replace the placeholders with the values from the results
patchResultPlaceholderInValue(String, List<JobResultContainer>) - Method in class com.inet.taskplanner.server.api.field.SelectInputField
Override to replace the placeholders with the values from the results
patchResultPlaceholderInValue(String, List<JobResultContainer>) - Method in class com.inet.taskplanner.server.api.field.TextAreaField
Override to replace the placeholders with the values from the results
patchResultPlaceholderInValue(String, List<JobResultContainer>) - Method in class com.inet.taskplanner.server.api.field.TextField
Override to replace the placeholders with the values from the results
patchSeriesPlaceholderInValue(String, Map<String, String>) - Method in class com.inet.taskplanner.server.api.field.Field
Override to replace the placeholders with the values from the series
patchSeriesPlaceholderInValue(String, Map<String, String>) - Method in class com.inet.taskplanner.server.api.field.FilenameField
Override to replace the placeholders with the values from the series
patchSeriesPlaceholderInValue(String, Map<String, String>) - Method in class com.inet.taskplanner.server.api.field.FolderField
Override to replace the placeholders with the values from the series
patchSeriesPlaceholderInValue(String, Map<String, String>) - Method in class com.inet.taskplanner.server.api.field.SelectInputField
Override to replace the placeholders with the values from the series
patchSeriesPlaceholderInValue(String, Map<String, String>) - Method in class com.inet.taskplanner.server.api.field.TextAreaField
Override to replace the placeholders with the values from the series
patchSeriesPlaceholderInValue(String, Map<String, String>) - Method in class com.inet.taskplanner.server.api.field.TextField
Override to replace the placeholders with the values from the series
PERMISSION_TASKPLANNER - Static variable in class com.inet.taskplanner.server.api.TaskPlanner
Permission required for users accessing the taskplanner.
PERMISSION_TASKPLANNER_ADMIN - Static variable in class com.inet.taskplanner.server.api.TaskPlanner
Permission required when a user must access the tasks of other users.
PLACEHOLDER_END_CHARACTER - Static variable in class com.inet.taskplanner.server.api.common.SeriesDependentFactory
The official end character of placeholder
PLACEHOLDER_START_CHARACTER - Static variable in class com.inet.taskplanner.server.api.common.SeriesDependentFactory
The official start character of placeholder
PRINT - Static variable in class com.inet.taskplanner.server.api.result.ResultFlavor
This flavor is used for printable results.
PrinterNotExists - com.inet.taskplanner.server.api.error.TaskPlannerCodes
 
PrintResult - Interface in com.inet.taskplanner.server.api.result
A result that can be print to a printer.
PrintResultActionBuilder - Class in com.inet.taskplanner.server.api.action
Use this to easily create definitions for a Print ResultAction.
PrintResultActionBuilder() - Constructor for class com.inet.taskplanner.server.api.action.PrintResultActionBuilder
 
PROGRESS - com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
This event is triggered by the executed Jobs and ResultActions.
Only in case of this type, the progress of an TaskEvent will have a meaningful value.
Event with this type includes a executionID.
ProgressEventListener - Interface in com.inet.taskplanner.server.api.event
This listener is used to get notified whenever a singular action or job made any progress.
progressUpdate(int) - Method in interface com.inet.taskplanner.server.api.event.ProgressEventListener
Called by the Job or ResultAction that has made progress
PROP_ATTACH_FILES - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
The attachment property used to create a ResultActionDefinition.
PROP_CRON_EXPRESSION - Static variable in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
The cron expression which determines the time when this trigger will start the task.
PROP_CUSTOM_INTERVAL - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
Every X weeks/days/months.
PROP_CUSTOM_INTERVALTYPE - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
PROP_CUSTOM_MONTHLY_CARDINALITY - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
At which day (1st, 2nd, last etc).
PROP_CUSTOM_MONTHLY_DAY_OF_MONTH - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
At which day to execute for monthly repetition.
PROP_CUSTOM_WEEKLY_DAYOFWEEK - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
At which day of week.
PROP_MESSAGE - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
The message property used to create a ResultActionDefinition.
PROP_RECEIVER - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
The receiver property used to create a ResultActionDefinition.
PROP_REPEAT_SELECT - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Key for the repeat-interval of this trigger.
PROP_START_DAY - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Key for the start day which specifies the earliest day for the execution.
PROP_START_TIME - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Key for the start time which specifies at which hour and minute of the day this trigger will fire.
PROP_SUBJECT - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
The subject property used to create a ResultActionDefinition.
PROP_WHICH_SELECT - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Key for the Monthly day setting, which determines on which day of the month this trigger fires.
PROPERTY_FILE - Static variable in class com.inet.taskplanner.server.api.series.json.JsonSeriesFactory
The json file property used to create a SeriesDefinition.
PROPERTY_FILE_PATH - Static variable in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Key of the property which holds the path to the file to observe.
PROPERTY_FILENAME_FORMAT - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
The format of the file names.
PROPERTY_FOLDER_PATH - Static variable in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Key of the property which holds the path to the folder to observe.
PROPERTY_TYPE - Static variable in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Key of the property type which determines whether a file or a folder must be observed.
PROTOCOL_FILE - Static variable in class com.inet.taskplanner.server.api.field.FolderField
Default protocol for the local server file system

Q

QUARTERLY - com.inet.taskplanner.server.api.trigger.time.RepeatInterval
The task will be triggered every 3 month one the day of month of the start date.

R

RangeField - Class in com.inet.taskplanner.server.api.field
A field that takes an integer number as input The field supports place holders from the TaskPlanner, which has to be accounted for
RangeField(String, String, SliderConfigProperty.SliderBound, SliderConfigProperty.SliderBound, boolean) - Constructor for class com.inet.taskplanner.server.api.field.RangeField
Construct the numeric field
RangeField.NumberRange - Class in com.inet.taskplanner.server.api.field
Number Range Response Value Holder
registerEventListener(TaskEventListener) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Register a listener which is to be notified about changes of tasks.
REMOVED - com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
 
removeJob(JobDefinition) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Removes a job from this task.
removeProperty(String) - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
Removes a property of this definition
removeProperty(String) - Method in class com.inet.taskplanner.server.api.job.ConditionDefinition
Removes a property of this definition
removeResultAction(ResultActionDefinition) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Removes a result action from this task.
removeTask(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Removes the task which has the given ID.
removeTrigger(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Removes a trigger from this task.
RepeatInterval - Enum in com.inet.taskplanner.server.api.trigger.time
These are repeating intervals which you can use for your TimeTrigger.
replaceSeriesPlaceholders(String, Map<String, String>) - Method in class com.inet.taskplanner.server.api.field.Field
Replace placeholders in given string with values in given properties.
Result - Interface in com.inet.taskplanner.server.api.result
A result is one object which has been produced by a Job and is processed by actions.
ResultAction - Class in com.inet.taskplanner.server.api.action
Performs some action after the jobs.
ResultAction() - Constructor for class com.inet.taskplanner.server.api.action.ResultAction
 
ResultActionDefinition - Class in com.inet.taskplanner.server.api.action
Definition of a ResultAction for a configured TaskExecution.
A ResultAction does something with the results of jobs.
ResultActionDefinition(String) - Constructor for class com.inet.taskplanner.server.api.action.ResultActionDefinition
Creates a new ResultActionDefinition instance.
ResultActionDefinition(String, Map<String, String>) - Constructor for class com.inet.taskplanner.server.api.action.ResultActionDefinition
Creates a new ResultActionDefinition instance.
ResultActionFactory<T extends ResultAction> - Class in com.inet.taskplanner.server.api.action
Base class for factories producing ResultAction components.
ResultActionFactory(String) - Constructor for class com.inet.taskplanner.server.api.action.ResultActionFactory
Creates a new ResultActionFactory instance.
ResultActionInfo - Class in com.inet.taskplanner.server.api.action
This holds information on how a ResultAction is to be displayed in the web GUI.
ResultActionInfo(String, String, String, URL, String) - Constructor for class com.inet.taskplanner.server.api.action.ResultActionInfo
Creates a new ResultActionInfo instance without fields.
ResultActionInfo(String, String, String, URL, String, List<Field>) - Constructor for class com.inet.taskplanner.server.api.action.ResultActionInfo
Creates a new ResultActionInfo instance with fields.
ResultActionInfo(String, String, String, URL, String, List<Field>, List<String>) - Constructor for class com.inet.taskplanner.server.api.action.ResultActionInfo
Creates a new ResultActionInfo instance with fields.
ResultContainer - Class in com.inet.taskplanner.server.api.job
Class representing the results of a job.
ResultContainer(List<Result>) - Constructor for class com.inet.taskplanner.server.api.job.ResultContainer
Creates a new ResultContainer instance.
ResultContainer(List<Result>, Map<String, String>) - Constructor for class com.inet.taskplanner.server.api.job.ResultContainer
Creates a new ResultContainer instance.
ResultFlavor - Class in com.inet.taskplanner.server.api.result
A ResultFlavor is an enum-like class representing the 'type' of data a Result contains.
ResultFlavor.FlavorLabel - Interface in com.inet.taskplanner.server.api.result
Functional Interface for the internationalization of the ResultFlavor.
run() - Method in class com.inet.taskplanner.server.api.job.Job
This runs the job when the TaskExecution is executed.
run() - Method in interface com.inet.taskplanner.server.api.trigger.Trigger.TriggerAction
Start the task if possible.

S

SECOND - com.inet.taskplanner.server.api.trigger.time.MonthlyDay
The second day of the month is used
SELECT - com.inet.taskplanner.server.api.field.FieldType
A select field with a predefined set of possible values
SELECT_INPUT - com.inet.taskplanner.server.api.field.FieldType
A select field which supports chunking behavior and custom renderers
SELECT_INPUT_MULTI - com.inet.taskplanner.server.api.field.FieldType
A select field which supports chunking behavior and custom renderers and multiple selection
SelectField - Class in com.inet.taskplanner.server.api.field
A field that allows to choose from a list of predefined values.
SelectField(String, String, ArrayList<LocalizedKey>) - Constructor for class com.inet.taskplanner.server.api.field.SelectField
Creates the field for selecting a value from a predefined list
SelectInputField - Class in com.inet.taskplanner.server.api.field
A field that allows to choose from a list of predefined values.
SelectInputField(String, String, int) - Constructor for class com.inet.taskplanner.server.api.field.SelectInputField
Creates the field for selecting a value from a predefined list
SelectInputFieldMulti - Class in com.inet.taskplanner.server.api.field
A field that allows to choose multiple values from a list of predefined values.
SelectInputFieldMulti(String, String, int) - Constructor for class com.inet.taskplanner.server.api.field.SelectInputFieldMulti
Creates the field for selecting a value from a predefined list
Series - Interface in com.inet.taskplanner.server.api.series
With a series the jobs and resultActions can be executed multiple times each with a defined set of properties.
SeriesDefinition - Class in com.inet.taskplanner.server.api.series
Definition of a Series for a TaskExecution with settings.
SeriesDefinition(String) - Constructor for class com.inet.taskplanner.server.api.series.SeriesDefinition
Creates a new SeriesDefinition instance.
SeriesDefinition(String, Map<String, String>) - Constructor for class com.inet.taskplanner.server.api.series.SeriesDefinition
Creates a new SeriesDefinition instance.
SeriesDependentFactory<COMPONENT,​DEFINITION extends AbstractDefinition<DEFINITION>,​INFO extends AbstractInfo,​SUMMARY extends SummaryInfo> - Class in com.inet.taskplanner.server.api.common
Factory for components whose properties depends on a Series which the user may have configured.
SeriesDependentFactory(String) - Constructor for class com.inet.taskplanner.server.api.common.SeriesDependentFactory
Creates a new SeriesFactory instance.
SeriesExecutionError - com.inet.taskplanner.server.api.error.TaskPlannerCodes
 
SeriesFactory<T extends Series> - Class in com.inet.taskplanner.server.api.series
Base class for factories producing Series components.
SeriesFactory(String) - Constructor for class com.inet.taskplanner.server.api.series.SeriesFactory
Creates a new SeriesFactory instance.
SeriesIndependentFactory<COMPONENT,​DEFINITION extends AbstractDefinition<DEFINITION>,​INFO extends AbstractInfo,​SUMMARY extends SummaryInfo> - Class in com.inet.taskplanner.server.api.common
Base class for component factories whose properties does not depend on the properties of a possibly configured series.
SeriesIndependentFactory(String) - Constructor for class com.inet.taskplanner.server.api.common.SeriesIndependentFactory
Creates a new SeriesFactory instance.
SeriesInfo - Class in com.inet.taskplanner.server.api.series
Contains information about how this kind of series is to be presented, what options with what type it has and how they interact with each other.
SeriesInfo(String, String, String, URL, String, List<Field>) - Constructor for class com.inet.taskplanner.server.api.series.SeriesInfo
Creates a new SeriesInfo instance with all optional fields.
ServerStartTriggerBuilder - Class in com.inet.taskplanner.server.api.trigger
Create a trigger which starts a task when the server was started.
ServerStartTriggerBuilder() - Constructor for class com.inet.taskplanner.server.api.trigger.ServerStartTriggerBuilder
 
ServerStartTriggerFactory - Class in com.inet.taskplanner.server.api.trigger.serverstart
Factory for ServerStartTriggers.
ServerStartTriggerFactory() - Constructor for class com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTriggerFactory
Creates the factory for Server Start triggers.
ServerStopTriggerFactory - Class in com.inet.taskplanner.server.api.trigger.serverstop
Factory for ServerStopTriggers.
ServerStopTriggerFactory() - Constructor for class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory
Creates the factory for Server Start triggers.
setActivated(boolean) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Mark this task as activated.
setAllowCustomValues(boolean) - Method in class com.inet.taskplanner.server.api.field.SelectInputField
Sets whether custom values are allowed to be entered
setAreResultsProcessable(boolean) - Method in class com.inet.taskplanner.server.api.job.JobResultContainer
Sets If the results of this contains are to be processed or not.
setCachedKeys(Set<String>) - Method in class com.inet.taskplanner.server.api.series.SeriesDefinition
Sets the set of keys from the factory to be cached.
setCondition(ConditionDefinition) - Method in class com.inet.taskplanner.server.api.job.JobDefinition
Sets the condition of this JobDefinition.
setConditionEntries(List<SummaryEntry>) - Method in class com.inet.taskplanner.server.api.job.JobSummaryInfo
Sets the summary entries for the optional condition
setConditions(List<FieldCondition>) - Method in class com.inet.taskplanner.server.api.field.Field
Sets the fields for the condition.
setDescription(String) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Use this method to set the description of the task.
setDisplay(String) - Method in class com.inet.taskplanner.server.api.field.SelectInputField
manually sets the display value this field should have
setDisplay(String) - Method in class com.inet.taskplanner.server.api.field.SelectInputFieldMulti
manually sets the display value this field should have
setEntries(List<SummaryEntry>) - Method in class com.inet.taskplanner.server.api.common.SummaryInfo
Sets the list of summary entries
setExecutionQualification(ExecutionQualification) - Method in class com.inet.taskplanner.server.api.action.ResultActionDefinition
Sets the executionQualification of this ResultActionDefinition
setFilter(List<String>) - Method in class com.inet.taskplanner.server.api.field.FileField
Sets the filter of allowed file names.
setFilter(List<String>) - Method in class com.inet.taskplanner.server.api.field.FileOrFolderField
Sets the filter of allowed file names.
setKey(String) - Method in class com.inet.taskplanner.server.api.field.Field
Sets the key that is stored in the definition
setLabel(String) - Method in class com.inet.taskplanner.server.api.field.Field
Sets the label to be should in front of the component
setName(String) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Set the display name of this task.
setPlaceholder(String) - Method in class com.inet.taskplanner.server.api.field.Field
Sets the placeholder text that is displayed if the field is left empty
setProgress(int) - Method in class com.inet.taskplanner.server.api.action.ResultAction
Sets the progress of this ResultAction and propagates it to the ProgressEventListener, if any.
setProgress(int) - Method in class com.inet.taskplanner.server.api.job.Job
Sets the progress of this Job and propagates it to the ProgressEventListener, if any.
setProperty(String, String) - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
Sets a property to the internal properties table.
setProperty(String, String) - Method in class com.inet.taskplanner.server.api.job.ConditionDefinition
Sets a property, defined by the key, to this definition
setProtocols(List<String>) - Method in class com.inet.taskplanner.server.api.field.FolderField
Sets the possible protocols.
setSeries(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Set the optional series definition of this task.
setType(FieldCondition.TYPE) - Method in class com.inet.taskplanner.server.api.field.FieldCondition
Sets the type of the condition like e.g.
setType(FieldType) - Method in class com.inet.taskplanner.server.api.field.Field
Sets the type of the field which defines how the field is displayed
setType(String) - Method in class com.inet.taskplanner.server.api.field.Field
Sets the type of the field which defines how the field is displayed
setUid(GUID) - Method in class com.inet.taskplanner.server.api.common.AbstractDefinition
Sets the unique identifier of this definition.
setUpdateValuesOnChange(boolean) - Method in class com.inet.taskplanner.server.api.field.Field
Sets whether the whole values of the fields in the current dialog should be updated if the value of the current field changes
setValue(String) - Method in class com.inet.taskplanner.server.api.field.Field
Sets the current value of the field
setValue(String) - Method in class com.inet.taskplanner.server.api.field.SelectInputField
Sets the current value of the field
setValue(String) - Method in class com.inet.taskplanner.server.api.field.SelectInputFieldMulti
Sets the current value of the field
setValueSavable(boolean) - Method in class com.inet.taskplanner.server.api.field.Field
Sets whether the value should be stored
SQL - Static variable in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
The SQL property used to create a SeriesDefinition.
startswith - com.inet.taskplanner.server.api.field.FieldCondition.OP
The field value starts with the given value
stopRequested() - Method in class com.inet.taskplanner.server.api.action.ResultAction
This method is called by the task executor in case the executor was requested to stop/cancel.
stopRequested() - Method in class com.inet.taskplanner.server.api.job.Job
This method is called by the task executor in case the executor was requested to stop/cancel.
STRING_TABLE - com.inet.taskplanner.server.api.field.FieldType
A table with string key:value pairs
StringTextResult - Class in com.inet.taskplanner.server.api.result
A Result which contains of human readable text.
StringTextResult(String, String) - Constructor for class com.inet.taskplanner.server.api.result.StringTextResult
Creates a new TextResult instance.
SummaryEntry - Class in com.inet.taskplanner.server.api.common
One detail-entry for the summary of components.
SummaryEntry(String, String) - Constructor for class com.inet.taskplanner.server.api.common.SummaryEntry
Creates a new SummaryEntry instance.
SummaryInfo - Class in com.inet.taskplanner.server.api.common
A summary information is a details summary of what is configured in the e.g.
SummaryInfo(List<SummaryEntry>) - Constructor for class com.inet.taskplanner.server.api.common.SummaryInfo
Create the summary information
supportsFlavor(ResultFlavor) - Method in interface com.inet.taskplanner.server.api.result.Result
Check if the given flavor is supported from this result.
supportsOneFlavorOf(List<ResultFlavor>) - Method in interface com.inet.taskplanner.server.api.result.Result
Check if one of the given flavors is supported.

T

TableField - Class in com.inet.taskplanner.server.api.field
A field that allows to add key-value pairs.
TableField(String, String, String[]) - Constructor for class com.inet.taskplanner.server.api.field.TableField
Construct the numeric field
TaskDefinition - Class in com.inet.taskplanner.server.api
This represents the settings of a task.
TaskDefinition(String) - Constructor for class com.inet.taskplanner.server.api.TaskDefinition
Creates a new TaskModel instance.
TaskDoesNotExist - com.inet.taskplanner.server.api.error.TaskPlannerCodes
 
TaskEvent - Class in com.inet.taskplanner.server.api.event
Event when a task was added, modified, deleted, activated, deactivated, started or execution finished.
TaskEvent(int, GUID, GUID) - Constructor for class com.inet.taskplanner.server.api.event.TaskEvent
Creates a new TaskEvent instance with a fixed type of TaskEvent.TaskEventType.PROGRESS
TaskEvent(TaskEvent.TaskEventType, GUID) - Constructor for class com.inet.taskplanner.server.api.event.TaskEvent
Creates a new TaskEvent instance.
TaskEvent(TaskEvent.TaskEventType, GUID, GUID) - Constructor for class com.inet.taskplanner.server.api.event.TaskEvent
Creates a new TaskEvent instance.
TaskEvent.TaskEventType - Enum in com.inet.taskplanner.server.api.event
Possible task events
TaskEventListener - Interface in com.inet.taskplanner.server.api.event
Listener which is notified when a task was changed or execution was started or completed.
TaskExecution - Interface in com.inet.taskplanner.server.api
Contains internal, non-configurable information about a planned task
TaskExecutionException - Exception in com.inet.taskplanner.server.api.error
Signals that the execution of a Job or ResultAction faced an error which it cannot handle.
TaskExecutionException(int, String, Throwable, Object...) - Constructor for exception com.inet.taskplanner.server.api.error.TaskExecutionException
Constructs a new exception with the specified detail message and cause.
TaskExecutionException(ErrorCode, Throwable, Object...) - Constructor for exception com.inet.taskplanner.server.api.error.TaskExecutionException
Constructs a new exception with the specified detail message and cause.
TaskExecutionException(Throwable) - Constructor for exception com.inet.taskplanner.server.api.error.TaskExecutionException
Create a wrapped exception.
TaskExecutionException(Throwable, ErrorCode) - Constructor for exception com.inet.taskplanner.server.api.error.TaskExecutionException
Create a wrapped exception.
TaskFieldListGenerator - Interface in com.inet.taskplanner.server.api.field
provides data entries for field type dropdowns in task fields as well as generating the actual task Field instances themselves
TaskPlanner - Class in com.inet.taskplanner.server.api
The main class of the taskplanner package.
TaskPlannerCodes - Enum in com.inet.taskplanner.server.api.error
Errors codes for errors occurring when using the TaskPlanner
TaskTemplateDefinition - Interface in com.inet.taskplanner.server.api.template
interface defining a "task template" which is a template to be used for creating pre-defined tasks with triggers, jobs, etc.
TEXT - Static variable in class com.inet.taskplanner.server.api.result.ResultFlavor
This flavor is used for textual data that is usually human readable.
TEXTAREA - com.inet.taskplanner.server.api.field.FieldType
A multiline text field
TextAreaField - Class in com.inet.taskplanner.server.api.field
A field that allows any multi line text.
TextAreaField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.TextAreaField
Creates the field for setting a multi line text
TextField - Class in com.inet.taskplanner.server.api.field
A text field that allows any value.
TextField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.TextField
Creates the field for setting a text
TEXTFIELD - com.inet.taskplanner.server.api.field.FieldType
A text field
TextResult - Interface in com.inet.taskplanner.server.api.result
A text result is result type which has been produced by a Job and is processed by actions.
By convention, it always implies the flavor TEXT.
Not all ResultAction can handle each FileResult, result flavors define the kind of information/data a FileResult represents and actions will handle only results they support.
THIRD - com.inet.taskplanner.server.api.trigger.time.MonthlyDay
The third day of the month is used
TIME - com.inet.taskplanner.server.api.field.FieldType
A time selection field
TimeField - Class in com.inet.taskplanner.server.api.field
A field that allows the definition of a time value.
TimeField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.TimeField
Creates the field for setting a time value
TimeTriggerBuilder - Class in com.inet.taskplanner.server.api.trigger
This can be used to easily create TimeTrigger definition.
TimeTriggerBuilder() - Constructor for class com.inet.taskplanner.server.api.trigger.TimeTriggerBuilder
 
TimeTriggerFactory - Class in com.inet.taskplanner.server.api.trigger.time
A task planner trigger that executes a task when the configured time settings apply
TimeTriggerFactory() - Constructor for class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Creates a new TimeTriggerFactory instance.
TimeTriggerForCustomSettings - Class in com.inet.taskplanner.server.api.trigger.time
Trigger implementation for the CUSTOM settings of the time trigger.
TimeTriggerForCustomSettings(TriggerDefinition) - Constructor for class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings
Create the trigger for given definition
toString() - Method in class com.inet.taskplanner.server.api.event.TaskEvent
toString() - Method in class com.inet.taskplanner.server.api.result.ResultFlavor
Trigger - Interface in com.inet.taskplanner.server.api.trigger
The Trigger initiates the execution of a task.
Trigger.TriggerAction - Interface in com.inet.taskplanner.server.api.trigger
Action to run if the trigger decides that time for execution has come.
TriggerDefinition - Class in com.inet.taskplanner.server.api.trigger
Defines a configured trigger for a task with its settings.
TriggerDefinition(String) - Constructor for class com.inet.taskplanner.server.api.trigger.TriggerDefinition
Creates a new TriggerDefinition instance.
TriggerDefinition(String, Map<String, String>) - Constructor for class com.inet.taskplanner.server.api.trigger.TriggerDefinition
Creates a new TriggerDefinition instance.
TriggerFactory<T extends Trigger> - Class in com.inet.taskplanner.server.api.trigger
Base class for factories producing Trigger components from TriggerDefinition configured by users.
TriggerFactory(String) - Constructor for class com.inet.taskplanner.server.api.trigger.TriggerFactory
Creates a new TriggerFactory instance.
TriggerInfo - Class in com.inet.taskplanner.server.api.trigger
Information about the GUI representation of a trigger.
TriggerInfo(String, String, String, URL, String) - Constructor for class com.inet.taskplanner.server.api.trigger.TriggerInfo
Creates a new info instance.
TriggerInfo(String, String, String, URL, String, List<Field>) - Constructor for class com.inet.taskplanner.server.api.trigger.TriggerInfo
Creates a new info instance.
TriggerInfo(String, String, String, URL, String, List<Field>, List<String>) - Constructor for class com.inet.taskplanner.server.api.trigger.TriggerInfo
Creates a new info instance.
TWOWEEKS - com.inet.taskplanner.server.api.trigger.time.RepeatInterval
The task will be triggered every two weeks on the day of the startDate.

U

UNIT_FIX_NUMBER - com.inet.taskplanner.server.api.field.FieldType
A integer unit field with a unit
UNIT_FLOAT_NUMBER - com.inet.taskplanner.server.api.field.FieldType
A float field with a unit
UnknownUser - com.inet.taskplanner.server.api.error.TaskPlannerCodes
 
unregisterEventListener(TaskEventListener) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Unregister specified event listener.
updateAttributes(PrinterJob, PrintRequestAttributeSet) - Method in interface com.inet.taskplanner.server.api.result.PrintResult
Set the attributes in the given attribute set.
updateTask(GUID, TaskDefinition) - Method in class com.inet.taskplanner.server.api.TaskPlanner
Update an existing task in the TaskPlanner.
updateValues(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
Update values according to the give definition.
updateValues(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Update values according to the give definition.
updateValues(DEFINITION, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesIndependentFactory
Update values according to the give definition.
updateValues(DEFINITION, SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory
Update values according to the give definition.
updateValues(DEFINITION, DEFINITION, SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory
Update values according to the give definition.
USERNAME - Static variable in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
The user name property used to create a SeriesDefinition.

V

validate() - Method in class com.inet.taskplanner.server.api.TaskDefinition
Validate all settings from this task.
This includes jobs with conditions, triggers, actions, series.
validate(GUID) - Method in class com.inet.taskplanner.server.api.TaskDefinition
Validate all settings from this task.
This includes jobs with conditions, triggers, actions, series.
validate(ResultActionDefinition, GUID) - Method in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory
Validate the given definition.
validate(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory
Validate the given definition.
validate(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory
Validate the given definition.
validate(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.series.json.JsonSeriesFactory
Validate the given definition.
validate(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
Validate the given definition.
validate(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Validate the given definition.
validate(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTriggerFactory
Validate the given definition.
validate(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTriggerFactory
Validate the given definition.
validate(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory
Validate the given definition.
validate(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory
Validate the given definition.
validate(DEFINITION, GUID) - Method in class com.inet.taskplanner.server.api.common.AbstractFactory
Validate the given definition.
validate(DEFINITION, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesIndependentFactory
Validate the given definition.
validate(DEFINITION, SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory
Validate the given definition.
validateCondition(JobDefinition) - Method in class com.inet.taskplanner.server.api.job.JobFactory
Validate the condition.
validateCondition(JobDefinition, SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.job.JobFactory
Validate the given condition.
validateCronExpression(String) - Static method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory
FOR INTERNAL USE ONLY.
ValidationException - Exception in com.inet.taskplanner.server.api.error
Thrown if validation of triggers, jobs or resultActions finds problems.
Note that this exception can contain more than one error! Error messages passed to this are expected to be localized.
ValidationException(String...) - Constructor for exception com.inet.taskplanner.server.api.error.ValidationException
Creates a new ValidationException instance.
ValidationException(List<String>) - Constructor for exception com.inet.taskplanner.server.api.error.ValidationException
Creates a new ValidationException instance with a list of errors.
VALUE_FILE - Static variable in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Observe a file and trigger if that file is created, deleted or modified.
VALUE_FOLDER - Static variable in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory
Observe a folder and trigger if files in that folder changed or the folder itself is changed.
valueOf(String) - Static method in enum com.inet.taskplanner.server.api.action.ExecutionQualification
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.inet.taskplanner.server.api.error.TaskPlannerCodes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.inet.taskplanner.server.api.field.FieldCondition.OP
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.inet.taskplanner.server.api.field.FieldCondition.TYPE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.inet.taskplanner.server.api.field.FieldType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class com.inet.taskplanner.server.api.result.ResultFlavor
Get the Flavor for the given key name.
valueOf(String) - Static method in enum com.inet.taskplanner.server.api.trigger.time.MonthlyDay
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.inet.taskplanner.server.api.trigger.time.RepeatInterval
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.inet.taskplanner.server.api.action.ExecutionQualification
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.inet.taskplanner.server.api.error.TaskPlannerCodes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.inet.taskplanner.server.api.field.FieldCondition.OP
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.inet.taskplanner.server.api.field.FieldCondition.TYPE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.inet.taskplanner.server.api.field.FieldType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class com.inet.taskplanner.server.api.result.ResultFlavor
Get all registered ResultFlavors.
values() - Static method in enum com.inet.taskplanner.server.api.trigger.time.MonthlyDay
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.inet.taskplanner.server.api.trigger.time.RepeatInterval
Returns an array containing the constants of this enum type, in the order they are declared.
visible - com.inet.taskplanner.server.api.field.FieldCondition.TYPE
The field is visible
visible(Field, FieldCondition.OP, String) - Static method in class com.inet.taskplanner.server.api.field.FieldCondition
Creates a visible field condition.
VisibleCondition - Class in com.inet.taskplanner.server.api.field
A field condition that changes the visibility
VisibleCondition(Field, FieldCondition.OP, String) - Constructor for class com.inet.taskplanner.server.api.field.VisibleCondition
Creates the field condition

W

WEEKLY - com.inet.taskplanner.server.api.trigger.time.RepeatInterval
The task will be triggered once a week on the day of the startDate.
withAttachendFiles(boolean) - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder
Specify whether File-based results must be appended to the email as attachments.
withDestinationFolder(File) - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder
Use the given destinationFolder as directory where generated file are saved.
withDestinationFolder(String) - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder
Use the given destinationFolder as directory where generated file are saved.
Use this if you need a placeholder in your path.
withDestinationFolder(Path) - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder
Use the given destinationFolder as directory where generated file are saved.
withFilenameFormat(String) - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder
Set the filename format of the attachments of the email.
withFileNameFormat(String) - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder
Set the format of the filename that are saved in the destination folder.
withHourAndMinute(int, int) - Method in class com.inet.taskplanner.server.api.trigger.TimeTriggerBuilder
Set the hour and minute of the day when the trigger must start the task.
The hour and minute is part of the startDate, but it determines the time of the day when the task is triggered.
withMessage(String) - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder
Set the message of the email.
withMonthlyDay(MonthlyDay) - Method in class com.inet.taskplanner.server.api.trigger.TimeTriggerBuilder
If you have set the repeat interval to RepeatInterval.MONTHLY, then you can configure here on which day of the month the task must be executed.
The default value is MonthlyDay.INITIAL, which means the day from the startDate is used.
withPassword(String) - Method in class com.inet.taskplanner.server.api.series.DbSeriesBuilder
Set the password for the user to log in the database.
withReceiver(String...) - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder
Sets the addresses of the receiver(s) of the email.
withRepeating(RepeatInterval) - Method in class com.inet.taskplanner.server.api.trigger.TimeTriggerBuilder
Set the repeating interval.
withSql(String) - Method in class com.inet.taskplanner.server.api.series.DbSeriesBuilder
Set the SQL query to use for data loading.
withStartDate(ZonedDateTime) - Method in class com.inet.taskplanner.server.api.trigger.TimeTriggerBuilder
Set the start date and time to the given date.
withSubject(String) - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder
Set the subject for the email.
withUrl(String) - Method in class com.inet.taskplanner.server.api.series.DbSeriesBuilder
Set the JDBC url to your database server.
Example: "jdbc:mysql://server:3306/databaseOne"
withUsername(String) - Method in class com.inet.taskplanner.server.api.series.DbSeriesBuilder
Set the username to use to log in the database.
WORKDAYS - com.inet.taskplanner.server.api.trigger.time.RepeatInterval
The task will be triggered on each workday, that is from monday to friday.

Y

YEARLY - com.inet.taskplanner.server.api.trigger.time.RepeatInterval
The task will be triggered once a year on the day (and month) of the startday.
A B C D E F G H I J L M N O P Q R S T U V W Y 
All Classes All Packages