Class JobInfo
java.lang.Object
com.inet.taskplanner.server.api.common.AbstractInfo
com.inet.taskplanner.server.api.job.JobInfo
Contains information about how this kind of job is to be presented, what options with what type it has and how they
interact with each other.
- Since:
- taskplanner 3.0
-
Constructor Summary
ConstructorsConstructorDescriptionJobInfo
(@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.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 TypeMethodDescription@Nullable ConditionInfo
Get information about the condition this job can have configured.Returns a list of placeholder key (without placeholder brackets)that are supported by this action.Methods inherited from class com.inet.taskplanner.server.api.common.AbstractInfo
getDescription, getDisplayName, getExtensionName, getFields, getHelpKey, getIconURL
-
Constructor Details
-
JobInfo
public JobInfo(@Nonnull @Nonnull String extensionName, @Nonnull @Nonnull String displayName, @Nonnull @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 aJobFactory
with this name.displayName
- localized display name of this jobdescription
- localized description of this jobiconURL
- URL to the icon for this jobhelpKey
- key of the help page to open for this jobconditionInfo
- information about condition(s) this job offersfields
- list of fields this job hasplaceholderKeys
- a list of placeholders (without placeholder brackets) that are supported by this action. Allows the definition of own placeholders that will only be used this action.- Since:
- taskplanner 3.0
-
JobInfo
public JobInfo(@Nonnull @Nonnull String extensionName, @Nonnull @Nonnull String displayName, @Nonnull @Nonnull String description, URL iconURL, String helpKey, ConditionInfo conditionInfo, @Nonnull @Nonnull List<Field> fields) Creates a new JobInfo instance with all optional fields.- Parameters:
extensionName
- unique name of the job extension. There must be aJobFactory
with this name.displayName
- localized display name of this jobdescription
- localized description of this jobiconURL
- URL to the icon for this jobhelpKey
- key of the help page to open for this jobconditionInfo
- information about condition(s) this job offersfields
- 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 aJobFactory
with this name.displayName
- localized display name of this jobdescription
- localized description of this jobiconURL
- URL to the icon for this jobhelpKey
- key of the help page to open for this jobfields
- list of fields this job hasplaceholderKeys
- a list of placeholders (without placeholder brackets) that are supported by this action. Allows the definition of own placeholders that will only be used this action.- 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 aJobFactory
with this name.displayName
- localized display name of this jobdescription
- localized description of this jobiconURL
- URL to the icon for this jobhelpKey
- key of the help page to open for this jobfields
- 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 aJobFactory
with this name.displayName
- localized display name of this jobdescription
- localized description of this jobiconURL
- URL to the icon for this jobhelpKey
- key of the help page to open for this job- Since:
- taskplanner 3.0
-
-
Method Details
-
getConditionInfo
Get information about the condition this job can have configured.- Returns:
- the condition info, can be null.
- Since:
- taskplanner 3.0
-
getPlaceholderKeys
Returns a list of placeholder key (without placeholder brackets)that are supported by this action.- Returns:
- a list of placeholder key (without placeholder brackets) that are supported by this action.
- Since:
- taskplanner 3.0
-