Index (taskplanner)

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 and Interfaces|All Packages|Constant Field Values|Serialized Form

A

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) - Constructor for class com.inet.taskplanner.server.api.common.AbstractDefinition: Creates a new definition instance.
AbstractFactory<COMPONENT, DEFINITION, INFO, SUMMARY> - 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) - 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 - Enum constant in enum class com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
activateTask(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner: Activates the task with the given ID.
ADDED - Enum constant in enum class 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: Adds a new task to the Task Planner.
addTimeZoneDifferenceHintIfRequired(ArrayList) - 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.
AfterTaskTriggerFactory - Class in com.inet.taskplanner.server.api.trigger.aftertask: Factory for AfterTaskTrigger.
AfterTaskTriggerFactory() - Constructor for class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Creates an AfterTaskTriggerFactory.
ALL_CONDITIONS_ARE_FULFILLED - Enum constant in enum class com.inet.taskplanner.server.api.action.ExecutionQualification
ALWAYS - Enum constant in enum class com.inet.taskplanner.server.api.action.ExecutionQualification
areResultsProcessable() - Method in class com.inet.taskplanner.server.api.job.JobResultContainer: Returns whether the results in this container should be processed.
AT_LEAST_ONE_CONDITION_IS_FULFILLED - Enum constant in enum class com.inet.taskplanner.server.api.action.ExecutionQualification

B

BOOLEAN - Enum constant in enum class 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
BooleanField(String, String, String, String) - Constructor for class com.inet.taskplanner.server.api.field.BooleanField: Creates a boolean field with text after the checkbox and a tooltip for the checkbox.
ByteArrayFileResult - Class in com.inet.taskplanner.server.api.result: A result that is based on an in-memory byte array.
ByteArrayFileResult(String, byte[]) - Constructor for class com.inet.taskplanner.server.api.result.ByteArrayFileResult: Creates 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: Cancels a currently executing task.
cancelTaskExecution(GUID, GUID, boolean) - Method in class com.inet.taskplanner.server.api.TaskPlanner: Cancels an execution of a currently executing task.
CannotSendEmail - Enum constant in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes
CategoryMessageProvider - Interface in com.inet.taskplanner.server.api.common: Provider interface for internationalized task planner category group labels.
checkDefinitionArgument(DEFINITION) - Method in class com.inet.taskplanner.server.api.common.AbstractFactory: Checks that the given definition is non-null and belongs to this factory.
cleanup() - Method in class com.inet.taskplanner.server.api.job.JobResultContainer: When result handling is finished, this method is called to release resources held by the results, such as closing streams or deleting temporary files as appropriate.
cleanup() - Method in class com.inet.taskplanner.server.api.job.ResultContainer: When result handling is finished, this method is called to release resources held by the results, such as closing streams or deleting temporary files as appropriate.
cleanup() - Method in class com.inet.taskplanner.server.api.result.ByteArrayFileResult: When result handling is finished, this method is called to release resources held by the result.
cleanup() - Method in class com.inet.taskplanner.server.api.result.LazyInputStreamFileResult: When result handling is finished, this method is called to release resources held by the result.
cleanup() - Method in class com.inet.taskplanner.server.api.result.LocalFileResult: When result handling is finished, this method is called to release resources held by the result.
cleanup() - Method in interface com.inet.taskplanner.server.api.result.Result: When result handling is finished, this method is called to release resources held by the result.
cleanup() - Method in class com.inet.taskplanner.server.api.result.StringTextResult: Releases resources held by this result.
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.
COLOR - Enum constant in enum class 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: Provides the core API for the Task Planner server functionality.
com.inet.taskplanner.server.api.action - package com.inet.taskplanner.server.api.action: Provides classes for managing result actions in the Task Planner.
com.inet.taskplanner.server.api.action.email - package com.inet.taskplanner.server.api.action.email: Provides classes for managing email-based result actions in the Task Planner.
com.inet.taskplanner.server.api.common - package com.inet.taskplanner.server.api.common: Provides common base classes and interfaces used throughout the Task Planner API.
com.inet.taskplanner.server.api.error - package com.inet.taskplanner.server.api.error: Provides classes for handling errors and exceptions in the Task Planner.
com.inet.taskplanner.server.api.event - package com.inet.taskplanner.server.api.event: Provides classes for managing events in the Task Planner.
com.inet.taskplanner.server.api.field - package com.inet.taskplanner.server.api.field: Provides classes for managing various types of input fields in the Task Planner.
com.inet.taskplanner.server.api.history - package com.inet.taskplanner.server.api.history: Provides classes for managing task execution history in the Task Planner.
com.inet.taskplanner.server.api.job - package com.inet.taskplanner.server.api.job: Provides classes for managing jobs in the Task Planner.
com.inet.taskplanner.server.api.result - package com.inet.taskplanner.server.api.result: Provides classes for handling task execution results in the Task Planner.
com.inet.taskplanner.server.api.series - package com.inet.taskplanner.server.api.series: Provides classes and interfaces for managing task series in the Task Planner.
com.inet.taskplanner.server.api.series.db - package com.inet.taskplanner.server.api.series.db: Provides classes for managing database-based task series in the Task Planner.
com.inet.taskplanner.server.api.series.folder - package com.inet.taskplanner.server.api.series.folder: Provides classes for managing folder-based task series in the Task Planner.
com.inet.taskplanner.server.api.series.json - package com.inet.taskplanner.server.api.series.json: Provides classes for managing JSON-based task series in the Task Planner.
com.inet.taskplanner.server.api.template - package com.inet.taskplanner.server.api.template: Provides classes for managing task templates in the Task Planner.
com.inet.taskplanner.server.api.trigger - package com.inet.taskplanner.server.api.trigger: Provides classes and interfaces for managing task triggers in the Task Planner.
com.inet.taskplanner.server.api.trigger.aftertask - package com.inet.taskplanner.server.api.trigger.aftertask
com.inet.taskplanner.server.api.trigger.cron - package com.inet.taskplanner.server.api.trigger.cron: Provides classes for managing cron-based triggers in the Task Planner.
com.inet.taskplanner.server.api.trigger.filechange - package com.inet.taskplanner.server.api.trigger.filechange: Provides classes for managing file change triggers in the Task Planner.
com.inet.taskplanner.server.api.trigger.lowmemory - package com.inet.taskplanner.server.api.trigger.lowmemory: Provides classes for managing low memory triggers in the Task Planner.
com.inet.taskplanner.server.api.trigger.serverstart - package com.inet.taskplanner.server.api.trigger.serverstart: Provides classes for managing server start triggers in the Task Planner.
com.inet.taskplanner.server.api.trigger.serverstop - package com.inet.taskplanner.server.api.trigger.serverstop: Provides classes for managing server stop triggers in the Task Planner.
com.inet.taskplanner.server.api.trigger.time - package com.inet.taskplanner.server.api.trigger.time: Provides classes for managing time-based triggers in the Task Planner.
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) - 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 the condition fields offered by the corresponding job.
ConditionInfo(List) - 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) - 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: Creates a deep copy of this model.
create() - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder: Finishes construction of the EmailResultAction and constructs a definition object that can be added to a task.
create() - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder: Finishes construction of the file-system ResultAction and constructs a definition object that 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: Creates a new definition for a trigger that starts the task when the server starts.
create() - Method in class com.inet.taskplanner.server.api.trigger.TimeTriggerBuilder: Finishes the configuration of the time trigger and creates a TriggerDefinition that can be added to tasks.
create(GUID) - Static method in class com.inet.taskplanner.server.api.action.NextTaskActionBuilder: Constructs 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 result action 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, ResultFlavor.FlavorLabel) - 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: Creates a new definition for a cron trigger using the given cron expression.
createForFile(String) - Static method in class com.inet.taskplanner.server.api.trigger.FileChangeTriggerBuilder: Creates a new definition for a file-change trigger using the given path string.
createForFile(Path) - Static method in class com.inet.taskplanner.server.api.trigger.FileChangeTriggerBuilder: Creates a new definition for a file-change trigger using the given path.
createForFolder(String) - Static method in class com.inet.taskplanner.server.api.trigger.FileChangeTriggerBuilder: Creates a new definition for a file-change trigger using the given path string.
createForFolder(Path) - Static method in class com.inet.taskplanner.server.api.trigger.FileChangeTriggerBuilder: Creates a new definition for a file-change trigger using the given path.
createFrom(DEFINITION, Map, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory: Creates a concrete object to be used by TaskPlanner from the given definition.
See SeriesDependentFactory.validate(AbstractDefinition, SeriesDefinition, GUID) for what is patched and replaced.
createFrom(DEFINITION, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesIndependentFactory: Creates a concrete object to be used by TaskPlanner 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: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(ResultActionDefinition, GUID) - Method in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.series.json.JsonSeriesFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTriggerFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTriggerFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory: Constructs a component (PRODUCT) from the given definition.
createInstanceFrom(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory: Constructs 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 that produces CronTrigger components.
CronTriggerFactory() - Constructor for class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory: Creates a new CronTriggerFactory instance.
CURRENCY - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A float field
CurrencyField - Class in com.inet.taskplanner.server.api.field: A field that takes a floating-point number as input and displays the currency symbol.
CurrencyField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.CurrencyField: Constructs the currency field for the given key and label.
CUSTOM - Enum constant in enum class 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)
customPatchDefinitionProperties(JobDefinition, Map, GUID) - Method in class com.inet.taskplanner.server.api.job.JobFactory: Customizes patching of definition properties.

D

DAILY - Enum constant in enum class 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, such as a priority.
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 - Enum constant in enum class 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 that load 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 - Enum constant in enum class com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType
deactivateTask(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner: Deactivates 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-text string.
DisableCondition - Class in com.inet.taskplanner.server.api.field: A field condition that changes the accessibility.
DisableCondition(Field, FieldCondition.OP, String) - Constructor for class com.inet.taskplanner.server.api.field.DisableCondition: Creates the field condition
disabled - Enum constant in enum class 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 result action.
EmailResultActionBuilder(String, String, String...) - Constructor for class com.inet.taskplanner.server.api.action.EmailResultActionBuilder: Creates a new EmailResultActionBuilder with subject, message, and receiver.
This adds file-based results as attachments.
EmailResultActionFactory - Class in com.inet.taskplanner.server.api.action.email: A result action factory for managing EmailResultAction settings and instances.
EmailResultActionFactory() - Constructor for class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory: Creates an instance of the factory.
encodePassword(String) - Static method in class com.inet.taskplanner.server.api.field.PasswordField: Encodes the given plain-text password with strong internal encryption.
equals - Enum constant in enum class 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) - Method in interface com.inet.taskplanner.server.api.trigger.Trigger.TriggerAction: Starts the task if possible.
executeAction(List, 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: Executes the task with the given ID.
executeTask(GUID, Map) - Method in class com.inet.taskplanner.server.api.TaskPlanner: Executes the task with the 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 - Enum constant in enum class 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 - Enum constant in enum class 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 the last executions of a TaskExecution.
ExecutionQualification - Enum Class 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.aftertask.AfterTaskTriggerFactory: Extension name of this trigger.
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, for example, a trigger or job.
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 Class in com.inet.taskplanner.server.api.field: The operation on the values to be applied
FieldCondition.TYPE - Enum Class in com.inet.taskplanner.server.api.field: The type of a field condition
FieldType - Enum Class in com.inet.taskplanner.server.api.field: Defines the type of field for the definition of, for example, triggers or jobs.
FILE - Enum constant in enum class 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 - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A file chooser that allows the selection of files or folders.
FileCannotBeWritten - Enum constant in enum class 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 a file-change trigger factory instance.
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 that are 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 or folder.
FileResult - Interface in com.inet.taskplanner.server.api.result: A file result is a result type that has been produced by a Job and is processed by actions.
By convention, it always implies the flavor FILE.
Not all ResultAction can handle every 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 file-system result action.
FileSystemResultActionBuilder(File) - Constructor for class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder: Creates a new FileSystemResultActionBuilder with the given destination directory.
FileSystemResultActionBuilder(String) - Constructor for class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder: Creates a new FileSystemResultActionBuilder with the given destination directory.
FileSystemResultActionBuilder(Path) - Constructor for class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder: Creates a new FileSystemResultActionBuilder with the given destination directory.
FILTER - Static variable in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory: Defines the file filter, such as *.pdf, for the files that should be used in this series.
FIRST - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.MonthlyDay: The first day of the month is used.
FIX_NUMBER - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: An integer field
FLOAT_NUMBER - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A float field
FloatField - Class in com.inet.taskplanner.server.api.field: A field that takes a floating-point number as input.
FloatField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.FloatField: Constructs the numeric field.
FloatField(String, String, List) - Constructor for class com.inet.taskplanner.server.api.field.FloatField: Constructs the numeric field, including a list of UnitConfigProperty.Unit values to select from, with automatic recalculation.
FOLDER - Enum constant in enum class 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 a 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 - Enum constant in enum class 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: Converts a string value into a RangeField.NumberRange.

G

generateFilterableFieldList() - Method in interface com.inet.taskplanner.server.api.field.TaskFieldListGenerator: Generates Task Planner field instances, including a filter-type dropdown, 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 - Enum constant in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes
get() - Method in interface com.inet.taskplanner.server.api.result.LazyInputStreamFileResult.InputStreamSupplier: Returns input stream.
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: Gets a list of the IDs of all tasks in the Task Planner.
getAvailableTaskIDs(GUID) - Method in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Resolve available tasks for the source-task selection.
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.
getCategory(String) - Method in interface com.inet.taskplanner.server.api.common.CategoryMessageProvider: Returns the internationalized category group label for the given category key.
getCondition() - Method in class com.inet.taskplanner.server.api.job.JobDefinition: Gets 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: Gets information about the condition that can be configured for this job.
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 known entries for the given field-type constant or ID.
getEntriesFor(String, String, String) - Method in interface com.inet.taskplanner.server.api.field.TaskFieldListGenerator: Returns known entries for the given field-type constant or ID, including filtering.
getErrorCodeNumber() - Method in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes
getErrors() - Method in exception class 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 if the task has a series configured.
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 execution history of this task.
This contains information about past and possibly 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: Gets the unique extension name 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: Gets the list of configurable fields.
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.LazyInputStreamFileResult: 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.LazyInputStreamFileResult: 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.LazyInputStreamFileResult: 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.LazyInputStreamFileResult: 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: Defines the types of data this result contains.
getFlavors() - Method in interface com.inet.taskplanner.server.api.result.FileResult: Defines the types of data this result contains.
getFlavors() - Method in class com.inet.taskplanner.server.api.result.LocalFileResult: Defines the types of data this result contains.
getFlavors() - Method in interface com.inet.taskplanner.server.api.result.PrintResult: Defines the types of data this result contains.
getFlavors() - Method in interface com.inet.taskplanner.server.api.result.Result: Defines the types of data this result contains.
getFlavors() - Method in interface com.inet.taskplanner.server.api.result.TextResult: Defines the types of data this result contains.
getGroup() - Method in class com.inet.taskplanner.server.api.TaskDefinition: Get the group name of this task.
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: Returns the URL of the icon for the component.
getInformation(DEFINITION, GUID) - Method in class com.inet.taskplanner.server.api.common.AbstractFactory: Returns an information object about components which can be produced with this factory, using the given definition to provide definition-specific information (such as placeholder keys that depend on the definition's properties).
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.trigger.aftertask.AfterTaskTriggerFactory: 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.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.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: Gets the TaskPlanner instance, creating one if none exists 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: Gets the unique key of the template.
getKeys(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.SeriesFactory: Get a set of keys that can be used in placeholder.
getKeys(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory: Get a set of keys that can be used in placeholder.
getKeywords() - Method in class com.inet.taskplanner.server.api.common.AbstractFactory: Returns additional keywords that can be used to find this component in the "add" filter bar.
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 shown 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 last executions.
getLastModified() - Method in interface com.inet.taskplanner.server.api.TaskExecution: Gets the time in ms since January 1, 1970 00:00:00.000 GMT when this task was last changed.
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 metadata properties for the job execution.
getMetaProperties() - Method in class com.inet.taskplanner.server.api.job.ResultContainer: Returns the additional metadata properties for the job execution.
getName() - Method in class com.inet.taskplanner.server.api.TaskDefinition: Gets 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) - 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) - Static method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory: FOR INTERNAL USE ONLY.
getNextExecutionsSummaryText(List) - 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 times of the next executions.
getNextExecutionTimes(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory: Returns the calculated times of the next executions.
getNextExecutionTimes(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.TriggerFactory: Returns the calculated times of the next executions.
getOwnerId() - Method in interface com.inet.taskplanner.server.api.TaskExecution: Gets 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 keys (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 keys (without placeholder brackets) that are supported by this job.
getPlaceholderKeys() - Method in class com.inet.taskplanner.server.api.trigger.TriggerInfo: Gets a list of placeholder keys (without placeholder brackets) that are supported by this trigger.
getProgress() - Method in class com.inet.taskplanner.server.api.event.TaskEvent: Returns the progress of the current task execution when 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: Gets 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: Gets 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.
getSelectableTaskNames(GUID, TaskExecution) - Method in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Build the selectable source-task names for the settings UI.
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 actions that were not executed because their conditions were not fulfilled.
getStateProperties() - Method in interface com.inet.taskplanner.server.api.TaskExecution: Returns a live, modifiable map of properties for this task's execution that enables task components to maintain state, for example, triggers might store what they have already checked.
getSummary() - Method in class com.inet.taskplanner.server.api.action.ResultActionDefinition: Gets summary information with a list of entries that summarize the settings for this result action in the web GUI.
getSummary() - Method in class com.inet.taskplanner.server.api.trigger.TriggerDefinition: Gets summary information about this trigger.
getSummary(DEFINITION) - Method in class com.inet.taskplanner.server.api.common.AbstractFactory: Constructs summary information for the component represented by the given definition.
getSummary(ResultActionDefinition) - Method in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory: Constructs summary information for the component represented by the given definition.
getSummary(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.db.DbSeriesFactory: Constructs summary information for the component represented by the given definition.
getSummary(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.folder.FolderSeriesFactory: Constructs summary information for the component represented by the given definition.
getSummary(SeriesDefinition) - Method in class com.inet.taskplanner.server.api.series.json.JsonSeriesFactory: Constructs summary information for the component represented by the given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Constructs summary information for the component represented by the given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTriggerFactory: Constructs summary information for the component represented by the given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory: Constructs summary information for the component represented by the given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory: Constructs summary information for the component represented by the given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTriggerFactory: Constructs summary information for the component represented by the given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory: Constructs summary information for the component represented by the given definition.
getSummary(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory: Constructs summary information for the component represented by the 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 creating a new task.
getTaskDefinition(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner: Retrieves the definition of an existing and stored task.
Note: The returned instance is a copy of the internal definition.
getTaskDefinition(GUID) - Method in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Resolve a task definition by ID.
getTaskExecution(GUID) - Method in class com.inet.taskplanner.server.api.TaskPlanner: Retrieve the execution data of an existing and stored task.
getTaskExecution(GUID) - Method in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Resolve current task execution for task-specific filtering.
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 the form of a String.
getText() - Method in interface com.inet.taskplanner.server.api.result.TextResult: Returns the content of the result in the form of a String.
getTextContent() - Method in class com.inet.taskplanner.server.api.result.StringTextResult: Returns a new UTF-8 encoded input stream containing this result's text.
getTextContent() - Method in interface com.inet.taskplanner.server.api.result.TextResult: Returns the content of the result in the 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 TaskEvent.TaskEventType of this event.
getType() - Method in class com.inet.taskplanner.server.api.field.Field: Returns the type of the field that defines how the field is displayed
getType() - Method in class com.inet.taskplanner.server.api.field.FieldCondition: Returns the type of the condition, for example FieldCondition.TYPE.visible.
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: Gets a list of the IDs of all tasks belonging to the specified 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 - Enum constant in enum class 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 group label.

H

handle(List) - Method in class com.inet.taskplanner.server.api.action.ResultAction: Handle the given results.
hasCurrentExecutionContext() - Static method in class com.inet.taskplanner.server.api.TaskExecutionContext: Returns whether there is currently an active task execution context for this thread/session.
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.
hasPlaceholderSet(String, GUID) - Method in class com.inet.taskplanner.server.api.job.JobFactory: Returns whether the given value contains at least one of the available placeholders for the job.
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.
HtmlTextAreaField - Class in com.inet.taskplanner.server.api.field: A field that allows multiline rich-text (HTML) content.
HtmlTextAreaField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.HtmlTextAreaField: Creates the field for setting multiline HTML text.

I

INITIAL - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.MonthlyDay: The day of the month from the start date 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.
isAutoResolvePlaceholders() - Method in class com.inet.taskplanner.server.api.job.JobFactory: Defines whether placeholders will be automatically replaced before the execute 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: Returns 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.
isCurrentExecutionManual() - Static method in class com.inet.taskplanner.server.api.TaskExecutionContext: Returns whether the current task execution was started manually (for example via the web GUI or API execution call).
isManualExecution() - Method in interface com.inet.taskplanner.server.api.history.HistoryEntry: Returns whether this execution was started manually (for example via the web GUI or API execution call).
isRunning() - Method in interface com.inet.taskplanner.server.api.TaskExecution: Checks whether this task is currently running (one or more executions).
isSupportedForSystemTasks() - Method in class com.inet.taskplanner.server.api.common.AbstractFactory: Returns whether components produced by this factory can be used in system tasks.
isSystemTask() - Method in class com.inet.taskplanner.server.api.TaskDefinition: Returns whether this task is marked as a system task.
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.CurrencyField: Checks whether the supplied value is a valid floating-point number or a placeholder expression in square brackets.
isValidValue(String) - Static method in class com.inet.taskplanner.server.api.field.FloatField: Checks whether the supplied value is a valid floating-point number or a placeholder expression in square brackets.
isValidValue(String) - Static method in class com.inet.taskplanner.server.api.field.NumberField: Checks whether the supplied value is a valid integer or a placeholder expression in square brackets.
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 unit of work that 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 the 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) - Constructor for class com.inet.taskplanner.server.api.job.JobDefinition: Creates a new JobDefinition instance.
JobFactory<T> - 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 presented, which options it has, and how those options interact.
JobInfo(String, String, String, URL, String, ConditionInfo, List) - 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, List) - 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) - 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, List) - Constructor for class com.inet.taskplanner.server.api.job.JobInfo: Creates a new JobInfo instance with fields.
JobInfo(String, String, String, URL, String, List, List) - 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 container returned by a Job.
JobResultContainer() - Constructor for class com.inet.taskplanner.server.api.job.JobResultContainer
JobSummaryInfo - Class in com.inet.taskplanner.server.api.job: Specialized summary information for jobs.
JobSummaryInfo(List, List) - Constructor for class com.inet.taskplanner.server.api.job.JobSummaryInfo: Creates 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 - Enum constant in enum class 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 label text.
LAST - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.MonthlyDay: The last day of the month is used.
LazyInputStreamFileResult - Class in com.inet.taskplanner.server.api.result: This file result obtains its content from an input-stream supplier and forwards it as a file result.
LazyInputStreamFileResult(String, LazyInputStreamFileResult.InputStreamSupplier) - Constructor for class com.inet.taskplanner.server.api.result.LazyInputStreamFileResult: Creates a lazy stream file result with a name and an input-stream supplier.
LazyInputStreamFileResult.InputStreamSupplier - Interface in com.inet.taskplanner.server.api.result: Interface for supplier of InputStream instances.
LINK - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A link with a 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: Creates 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 a low-memory trigger factory instance.

M

MODIFIED - Enum constant in enum class 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 - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.RepeatInterval: The task will be triggered once a month.
MonthlyDay - Enum Class in com.inet.taskplanner.server.api.trigger.time: For a monthly repeat interval this determines the day of the month for execution.
mustHandleResults(int, int) - Method in enum class com.inet.taskplanner.server.api.action.ExecutionQualification: Determines whether an action with this qualification must run based on the number of executed jobs and the number of executed jobs with fulfilled conditions.

N

needsLocalization(String) - Method in interface com.inet.taskplanner.server.api.template.TaskTemplateDefinition: Returns whether this key needs localization.
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 - Enum constant in enum class com.inet.taskplanner.server.api.action.ExecutionQualification
NONE - Enum constant in enum class 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 - Enum constant in enum class 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 changes, is executed, or an execution completes.
NotTaskOwner - Enum constant in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes
NUMBER_RANGE - Enum constant in enum class 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 as input.
NumberField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.NumberField: Constructs the numeric field.
NumberField(String, String, List) - Constructor for class com.inet.taskplanner.server.api.field.NumberField: Constructs the numeric field, including a list of UnitConfigProperty.Unit values to select from, with automatic recalculation.

O

OldFilesCannotBeDeleted - Enum constant in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes

P

parseTaskID(String) - Method in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Parse task ID from a persisted value.
PASSWORD - Enum constant in enum class 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 a text area that displays the value only when it is created.
patchDefinitionProperties(DEFINITION, Map, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory: Patches the properties of the given base definition with properties from the series properties.
patchDefinitionProperties(ResultActionDefinition, Map, GUID) - Method in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory: Patches the properties of the given base definition with properties from the series properties.
patchDefinitionProperties(JobDefinition, Map, GUID) - Method in class com.inet.taskplanner.server.api.job.JobFactory: Patches the properties of the given base definition with properties from the series properties.
patchResultPlaceholderInValue(String, List) - Method in class com.inet.taskplanner.server.api.field.Field: Overrides this method to replace placeholders with values from the results.
patchResultPlaceholderInValue(String, List) - Method in class com.inet.taskplanner.server.api.field.CurrencyField: Overrides this method to replace placeholders with values from the results.
patchResultPlaceholderInValue(String, List) - Method in class com.inet.taskplanner.server.api.field.FloatField: Overrides this method to replace placeholders with values from the results.
patchResultPlaceholderInValue(String, List) - Method in class com.inet.taskplanner.server.api.field.FolderField: Overrides this method to replace placeholders with values from the results.
patchResultPlaceholderInValue(String, List) - Method in class com.inet.taskplanner.server.api.field.HtmlTextAreaField: Overrides this method to replace placeholders with values from the results.
patchResultPlaceholderInValue(String, List) - Method in class com.inet.taskplanner.server.api.field.NumberField: Overrides this method to replace placeholders with values from the results.
patchResultPlaceholderInValue(String, List) - Method in class com.inet.taskplanner.server.api.field.SelectInputField: Overrides this method to replace placeholders with values from the results.
patchResultPlaceholderInValue(String, List) - Method in class com.inet.taskplanner.server.api.field.TextAreaField: Overrides this method to replace placeholders with values from the results.
patchResultPlaceholderInValue(String, List) - Method in class com.inet.taskplanner.server.api.field.TextField: Overrides this method to replace placeholders with values from the results.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.Field: Overrides this method to replace placeholders with values from the series.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.CurrencyField: Overrides this method to replace placeholders with values from the series.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.FilenameField: Overrides this method to replace placeholders with values from the series.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.FloatField: Overrides this method to replace placeholders with values from the series.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.FolderField: Overrides this method to replace placeholders with values from the series.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.HtmlTextAreaField: Overrides this method to replace placeholders with values from the series.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.NumberField: Overrides this method to replace placeholders with values from the series.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.SelectInputField: Overrides this method to replace placeholders with values from the series.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.TextAreaField: Overrides this method to replace placeholders with values from the series.
patchSeriesPlaceholderInValue(String, Map) - Method in class com.inet.taskplanner.server.api.field.TextField: Overrides this method to replace placeholders with 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 - Enum constant in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes
PrintResult - Interface in com.inet.taskplanner.server.api.result: A result that can be printed by 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 - Enum constant in enum class 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 single action or job makes progress.
progressUpdate(int) - Method in interface com.inet.taskplanner.server.api.event.ProgressEventListener: Called by the Job or ResultAction that 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_BCC - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory: The BCC property used to create a ResultActionDefinition.
PROP_CC - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory: The CC 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: TimeTriggerForCustomSettings.INTERVALTYPE_DAILY, TimeTriggerForCustomSettings.INTERVALTYPE_WEEKLY or TimeTriggerForCustomSettings.INTERVALTYPE_MONTHLY
PROP_CUSTOM_MONTHLY_CARDINALITY - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerForCustomSettings: The day cardinality (first, second, last, and so on).
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_PLAINTEXT - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory: Property indicating whether to treat PROP_MESSAGE as plain text rather than HTML.
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_SENDER - Static variable in class com.inet.taskplanner.server.api.action.email.EmailResultActionFactory: The optional sender/from address property used to create a ResultActionDefinition.
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 execution.
PROP_START_TIME - Static variable in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory: Key for the start time, which specifies the hour and minute of the day when this trigger fires.
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_COMPLETION_MODE - Static variable in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Property key for the completion mode.
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_SOURCE_TASK_ID - Static variable in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Property key for the selected source task ID.
PROPERTY_TYPE - Static variable in class com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory: Key of the property that 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 - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.RepeatInterval: The task will be triggered every three months on the day of the month of the start date.

R

RangeField - Class in com.inet.taskplanner.server.api.field: A field that takes an integer as input.
RangeField(String, String, SliderConfigProperty.SliderBound, SliderConfigProperty.SliderBound, boolean) - Constructor for class com.inet.taskplanner.server.api.field.RangeField: Constructs the numeric field.
RangeField.NumberRange - Class in com.inet.taskplanner.server.api.field: Holds a number range response value.
registerEventListener(TaskEventListener) - Method in class com.inet.taskplanner.server.api.TaskPlanner: Registers a listener that is to be notified about changes to tasks.
REMOVED - Enum constant in enum class 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 with the given ID.
removeTrigger(TriggerDefinition) - Method in class com.inet.taskplanner.server.api.TaskDefinition: Removes a trigger from this task.
RepeatInterval - Enum Class in com.inet.taskplanner.server.api.trigger.time: These are repeating intervals which you can use for your TimeTrigger.
replaceSeriesPlaceholders(String, Map) - Method in class com.inet.taskplanner.server.api.field.Field: Replaces placeholders in the given string with values from the given properties.
Result - Interface in com.inet.taskplanner.server.api.result: A result is an object produced by a Job and 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) - Constructor for class com.inet.taskplanner.server.api.action.ResultActionDefinition: Creates a new ResultActionDefinition instance.
ResultActionFactory<T> - 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) - Constructor for class com.inet.taskplanner.server.api.action.ResultActionInfo: Creates a new ResultActionInfo instance with fields.
ResultActionInfo(String, String, String, URL, String, List, List) - 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) - Constructor for class com.inet.taskplanner.server.api.job.ResultContainer: Creates a new ResultContainer instance.
ResultContainer(List, Map) - 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 internationalizing a 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: Starts the task if possible.

S

SECOND - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.MonthlyDay: The second day of the month is used.
SELECT - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A select field with a predefined set of possible values
SELECT_INPUT - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A select field which supports chunking behavior and custom renderers
SELECT_INPUT_MULTI - Enum constant in enum class 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 users to choose from a list of predefined values.
SelectField(String, String, ArrayList) - 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 users 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 users 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 multiple values from a predefined list.
Series - Interface in com.inet.taskplanner.server.api.series: With a series, the jobs and result actions 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) - Constructor for class com.inet.taskplanner.server.api.series.SeriesDefinition: Creates a new SeriesDefinition instance.
SeriesDependentFactory<COMPONENT, DEFINITION, INFO, SUMMARY> - Class in com.inet.taskplanner.server.api.common: Factory for components whose properties depend on a Series that the user may have configured.
SeriesDependentFactory(String) - Constructor for class com.inet.taskplanner.server.api.common.SeriesDependentFactory: Creates a new SeriesDependentFactory instance.
SeriesExecutionError - Enum constant in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes
SeriesExecutionErrorShort - Enum constant in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes
SeriesFactory<T> - 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, INFO, SUMMARY> - Class in com.inet.taskplanner.server.api.common: Base class for component factories whose properties do 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 SeriesIndependentFactory instance.
SeriesInfo - Class in com.inet.taskplanner.server.api.series: Contains information about how this kind of series is presented, which options it has, and how those options interact.
SeriesInfo(String, String, String, URL, String, List) - 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: Creates a trigger that starts a task when the server starts.
ServerStartTriggerBuilder() - Constructor for class com.inet.taskplanner.server.api.trigger.ServerStartTriggerBuilder
ServerStartTriggerFactory - Class in com.inet.taskplanner.server.api.trigger.serverstart: Factory for ServerStartTrigger instances.
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 ServerStopTrigger instances.
ServerStopTriggerFactory() - Constructor for class com.inet.taskplanner.server.api.trigger.serverstop.ServerStopTriggerFactory: Creates the factory for server stop triggers.
setActivated(boolean) - Method in class com.inet.taskplanner.server.api.TaskDefinition: Marks 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 whether the results in this container should be processed.
setCachedKeys(Set) - 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 job definition.
setConditionEntries(List) - Method in class com.inet.taskplanner.server.api.job.JobSummaryInfo: Sets the summary entries for the optional condition.
setConditions(List) - 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: Sets the description stored in this task definition.
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) - 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) - Method in class com.inet.taskplanner.server.api.field.FileField: Sets the filter of allowed file names.
setFilter(List) - Method in class com.inet.taskplanner.server.api.field.FileOrFolderField: Sets the filter of allowed file names.
setGroup(String) - Method in class com.inet.taskplanner.server.api.TaskDefinition: Set the group name of this task.
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 shown in front of the component.
setName(String) - Method in class com.inet.taskplanner.server.api.TaskDefinition: Sets 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) - 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.
setSystemTask(boolean) - Method in class com.inet.taskplanner.server.api.TaskDefinition: Mark this task as a system task or unset it.
setTriggerProperties(Map) - Method in interface com.inet.taskplanner.server.api.series.Series: injects the trigger placeholder properties in case the series needs to replace placeholder values
setType(FieldCondition.TYPE) - Method in class com.inet.taskplanner.server.api.field.FieldCondition: Sets the type of the condition, for example FieldCondition.TYPE.visible.
setType(FieldType) - Method in class com.inet.taskplanner.server.api.field.Field: Sets the type of the field that defines how the field is displayed
setType(String) - Method in class com.inet.taskplanner.server.api.field.Field: Sets the type of the field that 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 - Enum constant in enum class 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 when it is requested to stop or cancel.
stopRequested() - Method in class com.inet.taskplanner.server.api.job.Job: This method is called by the task executor when it is requested to stop or cancel.
STRING_TABLE - Enum constant in enum class 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 that contains human-readable text.
StringTextResult(String, String) - Constructor for class com.inet.taskplanner.server.api.result.StringTextResult: Creates a new StringTextResult 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: Summary information is a detailed description of what is configured in, for example, a trigger or job.
SummaryInfo(List) - 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: Checks whether the given flavor is supported by this result.
supportsOneFlavorOf(List) - Method in interface com.inet.taskplanner.server.api.result.Result: Checks whether one of the given flavors is supported.

T

TableField - Class in com.inet.taskplanner.server.api.field: A field that allows key-value pairs to be added.
TableField(String, String, String[]) - Constructor for class com.inet.taskplanner.server.api.field.TableField: Constructs a table field whose columns are defined by the supplied column names.
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 TaskDefinition instance.
TaskDoesNotExist - Enum constant in enum class 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 the fixed type 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 Class in com.inet.taskplanner.server.api.event: Possible task events
TaskEventListener - Interface in com.inet.taskplanner.server.api.event: Listener that is notified when a task changes or an execution starts or completes.
TaskExecution - Interface in com.inet.taskplanner.server.api: Contains internal, non-configurable information about a planned task
TaskExecutionContext - Class in com.inet.taskplanner.server.api: Accesses runtime information for the current task execution.
TaskExecutionException - Exception Class 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 class 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 class com.inet.taskplanner.server.api.error.TaskExecutionException: Constructs a new exception with the specified detail message and cause.
TaskExecutionException(Throwable) - Constructor for exception class com.inet.taskplanner.server.api.error.TaskExecutionException: Creates a wrapped exception.
TaskExecutionException(Throwable, ErrorCode) - Constructor for exception class com.inet.taskplanner.server.api.error.TaskExecutionException: Creates a wrapped exception.
TaskFieldListGenerator - Interface in com.inet.taskplanner.server.api.field: Provides data entries for field-type dropdowns in task fields and generates the corresponding task field instances.
TaskPlanner - Class in com.inet.taskplanner.server.api: The main class of the Task Planner package.
TaskPlannerCodes - Enum Class in com.inet.taskplanner.server.api.error: Error codes for errors occurring when using the TaskPlanner.
TaskTemplateDefinition - Interface in com.inet.taskplanner.server.api.template: Interface defining a "task template" that is used for creating predefined 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 - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A multiline text field
TEXTAREA_HTML - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A multiline text field with HTML (rich text) editing capabilities
TextAreaField - Class in com.inet.taskplanner.server.api.field: A field that allows any multiline text.
TextAreaField(String, String) - Constructor for class com.inet.taskplanner.server.api.field.TextAreaField: Creates the field for setting multiline 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 - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A text field
TextResult - Interface in com.inet.taskplanner.server.api.result: A text result is a result type that has been produced by a Job and is processed by actions.
By convention, it always implies the flavor TEXT.
Not all ResultAction can handle every TextResult; result flavors define the kind of information/data a TextResult represents, and actions will handle only results they support.
The [jobresult] placeholder - Section in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder
THIRD - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.MonthlyDay: The third day of the month is used.
TIME - Enum constant in enum class 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: Creates the trigger for the 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 it is time for execution.
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) - Constructor for class com.inet.taskplanner.server.api.trigger.TriggerDefinition: Creates a new TriggerDefinition instance.
TriggerFactory<T> - 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) - Constructor for class com.inet.taskplanner.server.api.trigger.TriggerInfo: Creates a new info instance.
TriggerInfo(String, String, String, URL, String, List, List) - Constructor for class com.inet.taskplanner.server.api.trigger.TriggerInfo: Creates a new info instance.
TWOWEEKS - Enum constant in enum class 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 - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: An integer field with a unit
UNIT_FLOAT_NUMBER - Enum constant in enum class com.inet.taskplanner.server.api.field.FieldType: A float field with a unit
UnknownUser - Enum constant in enum class 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: Sets the attributes in the given attribute set.
updateTask(GUID, TaskDefinition) - Method in class com.inet.taskplanner.server.api.TaskPlanner: Updates an existing task in the Task Planner.
updateValues(DEFINITION, DEFINITION, SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory: Updates values according to the given definition.
updateValues(DEFINITION, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesIndependentFactory: Updates values according to the given definition.
updateValues(DEFINITION, SeriesDefinition, GUID) - Method in class com.inet.taskplanner.server.api.common.SeriesDependentFactory: Updates values according to the given definition.
updateValues(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.cron.CronTriggerFactory: Updates values according to the given definition.
updateValues(TriggerDefinition, GUID) - Method in class com.inet.taskplanner.server.api.trigger.time.TimeTriggerFactory: Updates values according to the given 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(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: Validates the given definition.
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.aftertask.AfterTaskTriggerFactory: 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.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.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.
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.
validateNoAfterTaskLoop(GUID, GUID, List) - Method in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Validate that choosing the source task does not create a cycle in after-task dependencies.
ValidationException - Exception Class 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 class com.inet.taskplanner.server.api.error.ValidationException: Creates a new ValidationException instance.
ValidationException(List) - Constructor for exception class com.inet.taskplanner.server.api.error.ValidationException: Creates a new ValidationException instance with a list of errors.
VALUE_COMPLETION_ALWAYS - Static variable in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Trigger should execute after each finished execution.
VALUE_COMPLETION_FAILURE - Static variable in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Trigger should execute only after failed executions.
VALUE_COMPLETION_SUCCESS - Static variable in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Trigger should execute only after successful executions.
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: Observes a folder and triggers if files in that folder change or the folder itself changes.
valueOf(String) - Static method in enum class com.inet.taskplanner.server.api.action.ExecutionQualification: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.inet.taskplanner.server.api.field.FieldCondition.OP: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.inet.taskplanner.server.api.field.FieldCondition.TYPE: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.inet.taskplanner.server.api.field.FieldType: Returns the enum constant of this class 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 class com.inet.taskplanner.server.api.trigger.time.MonthlyDay: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.inet.taskplanner.server.api.trigger.time.RepeatInterval: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.inet.taskplanner.server.api.action.ExecutionQualification: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.inet.taskplanner.server.api.error.TaskPlannerCodes: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.inet.taskplanner.server.api.event.TaskEvent.TaskEventType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.inet.taskplanner.server.api.field.FieldCondition.OP: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.inet.taskplanner.server.api.field.FieldCondition.TYPE: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.inet.taskplanner.server.api.field.FieldType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in class com.inet.taskplanner.server.api.result.ResultFlavor: Gets all registered result flavors.
values() - Static method in enum class com.inet.taskplanner.server.api.trigger.time.MonthlyDay: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.inet.taskplanner.server.api.trigger.time.RepeatInterval: Returns an array containing the constants of this enum class, in the order they are declared.
visible - Enum constant in enum class 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 - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.RepeatInterval: The task will be triggered once a week on the day of the startDate.
withAttachedFiles(boolean) - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder: Specifies whether file-based results must be appended to the email as attachments.
withAttachendFiles(boolean) - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder: Deprecated.
As of version 26.10, use EmailResultActionBuilder.withAttachedFiles(boolean) instead.
withDestinationFolder(File) - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder: Uses the given destinationFolder as the directory where generated files are saved.
withDestinationFolder(String) - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder: Uses the given destinationFolder as the directory where generated files are saved.
Use this if you need a placeholder in your path.
withDestinationFolder(Path) - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder: Uses the given destinationFolder as the directory where generated files are saved.
withFilenameFormat(String) - Method in class com.inet.taskplanner.server.api.action.EmailResultActionBuilder: Sets the filename format of the email attachments.
withFileNameFormat(String) - Method in class com.inet.taskplanner.server.api.action.FileSystemResultActionBuilder: Sets the format of the filenames 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 are part of the start date and determine the time of 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 the day of the month on which 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: Sets 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 - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.RepeatInterval: The task will be triggered on each workday, that is from Monday to Friday.
wouldCreateDependencyLoop(GUID, GUID, List) - Method in class com.inet.taskplanner.server.api.trigger.aftertask.AfterTaskTriggerFactory: Check whether choosing the selected source task for the current task forms a cycle in the combined graph of AfterTask triggers and NextTask actions.

Y

YEARLY - Enum constant in enum class com.inet.taskplanner.server.api.trigger.time.RepeatInterval: The task will be triggered once a year on the day and month of the start date.

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 and Interfaces|All Packages|Constant Field Values|Serialized Form