Class ResultActionInfo
java.lang.Object
com.inet.taskplanner.server.api.common.AbstractInfo
com.inet.taskplanner.server.api.action.ResultActionInfo
This holds information on how a
ResultAction is to be displayed in the web GUI.- Since:
- taskplanner 3.0
-
Constructor Summary
ConstructorsConstructorDescriptionResultActionInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey) Creates a new ResultActionInfo instance without fields.ResultActionInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey, List<Field> fields) Creates a new ResultActionInfo instance with fields.ResultActionInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey, List<Field> fields, List<String> placeholderKeys) Creates a new ResultActionInfo instance with fields. -
Method Summary
Modifier and TypeMethodDescriptionReturns 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
-
ResultActionInfo
public ResultActionInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey, List<Field> fields, List<String> placeholderKeys) Creates a new ResultActionInfo instance with fields.- Parameters:
extensionName- the unique extensionName, there must be aJobFactoryfor this extensionName.displayName- localized name of the resultAction to showdescription- localized description of the resultAction to showiconURL- url to the icon of the resultActionhelpKey- key of the helppage to open for this resultActionfields- List of fields which represents the editable properties of the resultActionplaceholderKeys- 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
-
ResultActionInfo
public ResultActionInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey, List<Field> fields) Creates a new ResultActionInfo instance with fields.- Parameters:
extensionName- the unique extensionName, there must be aJobFactoryfor this extensionName.displayName- localized name of the resultAction to showdescription- localized description of the resultAction to showiconURL- url to the icon of the resultActionhelpKey- key of the helppage to open for this resultActionfields- List of fields which represents the editable properties of the resultAction- Since:
- taskplanner 3.0
-
ResultActionInfo
public ResultActionInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey) Creates a new ResultActionInfo instance without fields.- Parameters:
extensionName- the unique extensionName, there must be aJobFactoryfor this extensionName.displayName- localized name of the resultAction to showdescription- localized description of the resultAction to showiconURL- url to the icon of the resultActionhelpKey- key of the helppage to open for this resultAction- Since:
- taskplanner 3.0
-
-
Method Details
-
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
-