Class TriggerInfo
- java.lang.Object
-
- com.inet.taskplanner.server.api.common.AbstractInfo
-
- com.inet.taskplanner.server.api.trigger.TriggerInfo
-
public final class TriggerInfo extends AbstractInfo
Information about the GUI representation of a trigger.- Since:
- taskplanner 3.0
- See Also:
AbstractInfo
-
-
Constructor Summary
Constructors Constructor Description TriggerInfo(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey)
Creates a new info instance.TriggerInfo(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey, java.util.List<Field> fields)
Creates a new info instance.TriggerInfo(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey, java.util.List<Field> fields, java.util.List<java.lang.String> placeholderKeys)
Creates a new info instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>
getPlaceholderKeys()
Get 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 Detail
-
TriggerInfo
public TriggerInfo(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey, java.util.List<Field> fields, java.util.List<java.lang.String> placeholderKeys)
Creates a new info instance.- Parameters:
extensionName
- the unique extensionName, there must be aTriggerFactory
for this extensionName.displayName
- localized name of the trigger to showdescription
- localized description of the trigger to showiconURL
- url to the icon of the triggerhelpKey
- key of the helppage to open for this triggerfields
- List of fields which represents the editable properties of the triggerplaceholderKeys
- a list of placeholders (without placeholder brackets) that are supported by this trigger.- Throws:
java.lang.IllegalArgumentException
- if extensionName, displayName, description, or fields are null- Since:
- taskplanner 20.4
-
TriggerInfo
public TriggerInfo(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey, java.util.List<Field> fields)
Creates a new info instance.- Parameters:
extensionName
- the unique extensionName, there must be aTriggerFactory
for this extensionName.displayName
- localized name of the trigger to showdescription
- localized description of the trigger to showiconURL
- url to the icon of the triggerhelpKey
- key of the helppage to open for this triggerfields
- List of fields which represents the editable properties of the trigger- Throws:
java.lang.IllegalArgumentException
- if extensionName, displayName, description, or fields are null- Since:
- taskplanner 3.0
-
TriggerInfo
public TriggerInfo(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey)
Creates a new info instance.- Parameters:
extensionName
- the unique extensionName, there must be aTriggerFactory
for this extensionName.displayName
- localized name of the trigger to showdescription
- localized description of the trigger to showiconURL
- url to the icon of the triggerhelpKey
- key of the helppage to open for this trigger- Throws:
java.lang.IllegalArgumentException
- if extensionName, displayName or description are null- Since:
- taskplanner 3.0
-
-
Method Detail
-
getPlaceholderKeys
public java.util.List<java.lang.String> getPlaceholderKeys()
Get 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 20.4
-
-