Class ResultActionInfo

java.lang.Object

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

com.inet.taskplanner.server.api.action.ResultActionInfo

@JsonData
public final class ResultActionInfo
extends AbstractInfo

This holds information on how a ResultAction is to be displayed in the web GUI.

Since:

taskplanner 3.0

Constructor Summary

Constructors

Constructor	Description
ResultActionInfo(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 Type	Method	Description
List<String>	getPlaceholderKeys()	Returns a list of placeholder keys (without placeholder brackets) that are supported by this action.

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

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 extension name; there must be a ResultActionFactory for this extension name.

displayName - localized name of the result action to show

description - localized description of the result action to show

iconURL - URL to the icon of the result action

helpKey - key of the help page to open for this result action

fields - list of fields that represent the editable properties of the result action

placeholderKeys - a list of placeholders (without placeholder brackets) supported by this action. Allows the definition of custom placeholders that will only be used by 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 extension name; there must be a ResultActionFactory for this extension name.

displayName - localized name of the result action to show

description - localized description of the result action to show

iconURL - URL to the icon of the result action

helpKey - key of the help page to open for this result action

fields - list of fields that represent the editable properties of the result action

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 extension name; there must be a ResultActionFactory for this extension name.

displayName - localized name of the result action to show

description - localized description of the result action to show

iconURL - URL to the icon of the result action

helpKey - key of the help page to open for this result action

Since:

taskplanner 3.0

Method Details

getPlaceholderKeys

public List<String> getPlaceholderKeys()

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

Returns:

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

Since:

taskplanner 3.0