Class JobInfo

java.lang.Object

com.inet.taskplanner.server.api.common.AbstractInfo

com.inet.taskplanner.server.api.job.JobInfo

@JsonData
public final class JobInfo
extends AbstractInfo

Contains information about how this kind of job is presented, which options it has, and how those options interact.

Since:

taskplanner 3.0

Constructor Summary

Constructors

Constructor	Description
JobInfo(@Nonnull String extensionName, @Nonnull String displayName, @Nonnull String description, URL iconURL, String helpKey, ConditionInfo conditionInfo, @Nonnull List<Field> fields)	Creates a new JobInfo instance with all optional fields.
JobInfo(@Nonnull String extensionName, @Nonnull String displayName, @Nonnull String description, URL iconURL, String helpKey, ConditionInfo conditionInfo, List<Field> fields, List<String> placeholderKeys)	Creates a new JobInfo instance with all optional fields.
JobInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey)	Creates a new JobInfo instance with only required fields.
JobInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey, List<Field> fields)	Creates a new JobInfo instance with fields.
JobInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey, List<Field> fields, List<String> placeholderKeys)	Creates a new JobInfo instance with fields.

Method Summary

Modifier and Type	Method	Description
@Nullable ConditionInfo	getConditionInfo()	Gets information about the condition that can be configured for this job.
List<String>	getPlaceholderKeys()	Returns a list of placeholder keys (without placeholder brackets) that are supported by this job.

Methods inherited from class AbstractInfo

getDescription, getDisplayName, getExtensionName, getFields, getHelpKey, getIconURL

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JobInfo

public JobInfo(@Nonnull String extensionName,
 @Nonnull String displayName,
 @Nonnull String description,
 URL iconURL,
 String helpKey,
 ConditionInfo conditionInfo,
 List<Field> fields,
 List<String> placeholderKeys)

Creates a new JobInfo instance with all optional fields.

Parameters:

extensionName - unique name of the job extension. There must be a JobFactory with this name.

displayName - localized display name of this job

description - localized description of this job

iconURL - URL to the icon for this job

helpKey - key of the help page to open for this job

conditionInfo - information about condition(s) this job offers

fields - list of fields this job has

placeholderKeys - a list of placeholders (without placeholder brackets) that are supported by this job. Allows the definition of custom placeholders that will only be used by this job.

Since:

taskplanner 3.0

JobInfo

public JobInfo(@Nonnull String extensionName,
 @Nonnull String displayName,
 @Nonnull String description,
 URL iconURL,
 String helpKey,
 ConditionInfo conditionInfo,
 @Nonnull List<Field> fields)

Creates a new JobInfo instance with all optional fields.

Parameters:

extensionName - unique name of the job extension. There must be a JobFactory with this name.

displayName - localized display name of this job

description - localized description of this job

iconURL - URL to the icon for this job

helpKey - key of the help page to open for this job

conditionInfo - information about condition(s) this job offers

fields - list of fields this job has

Since:

taskplanner 3.0

JobInfo

public JobInfo(String extensionName,
 String displayName,
 String description,
 URL iconURL,
 String helpKey,
 List<Field> fields,
 List<String> placeholderKeys)

Creates a new JobInfo instance with fields.

Parameters:

extensionName - unique name of the job extension. There must be a JobFactory with this name.

displayName - localized display name of this job

description - localized description of this job

iconURL - URL to the icon for this job

helpKey - key of the help page to open for this job

fields - list of fields this job has

placeholderKeys - a list of placeholders (without placeholder brackets) that are supported by this job. Allows the definition of custom placeholders that will only be used by this job.

Since:

taskplanner 3.0

JobInfo

public JobInfo(String extensionName,
 String displayName,
 String description,
 URL iconURL,
 String helpKey,
 List<Field> fields)

Creates a new JobInfo instance with fields.

Parameters:

extensionName - unique name of the job extension. There must be a JobFactory with this name.

displayName - localized display name of this job

description - localized description of this job

iconURL - URL to the icon for this job

helpKey - key of the help page to open for this job

fields - list of fields this job has

Since:

taskplanner 3.0

JobInfo

public JobInfo(String extensionName,
 String displayName,
 String description,
 URL iconURL,
 String helpKey)

Creates a new JobInfo instance with only required fields.

Parameters:

extensionName - unique name of the job extension. There must be a JobFactory with this name.

displayName - localized display name of this job

description - localized description of this job

iconURL - URL to the icon for this job

helpKey - key of the help page to open for this job

Since:

taskplanner 3.0

Method Details

getConditionInfo

public @Nullable ConditionInfo getConditionInfo()

Gets information about the condition that can be configured for this job.

Returns:

the condition information, or null.

Since:

taskplanner 3.0

getPlaceholderKeys

public List<String> getPlaceholderKeys()

Returns a list of placeholder keys (without placeholder brackets) that are supported by this job.

Returns:

a list of placeholder keys (without placeholder brackets) that are supported by this job.

Since:

taskplanner 3.0