Class LowMemoryTriggerFactory
- All Implemented Interfaces:
com.inet.plugin.NamedExtension
LowMemoryTrigger
.- Since:
- 22.10
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTrigger
createInstanceFrom
(@Nonnull TriggerDefinition definition, @Nullable com.inet.id.GUID taskID) Construct a component (PRODUCT) from the given definition.getInformation
(@Nullable com.inet.id.GUID taskID) Returns an information object about components which can be produced with this factory.getSummary
(@Nonnull TriggerDefinition definition) Construct Summary infos for the component represented by given definition.boolean
Whether the (COMPONENT) is available or not.void
validate
(@Nonnull TriggerDefinition definition, com.inet.id.GUID taskID) Validate the given definition.Methods inherited from class com.inet.taskplanner.server.api.trigger.TriggerFactory
getNextExecutionTimes
Methods inherited from class com.inet.taskplanner.server.api.common.SeriesIndependentFactory
createFrom, updateValues
Methods inherited from class com.inet.taskplanner.server.api.common.AbstractFactory
checkDefinitionArgument, createInstanceFrom, getExtensionName
-
Field Details
-
EXTENSION_NAME
Name of the low memory trigger extension- See Also:
-
-
Constructor Details
-
LowMemoryTriggerFactory
public LowMemoryTriggerFactory()Creates instance of low memory trigger factory.- Since:
- 22.10
-
-
Method Details
-
createInstanceFrom
protected com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTrigger createInstanceFrom(@Nonnull @Nonnull TriggerDefinition definition, @Nullable @Nullable com.inet.id.GUID taskID) Construct a component (PRODUCT) from the given definition.- Overrides:
createInstanceFrom
in classAbstractFactory<com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTrigger,
TriggerDefinition, TriggerInfo, SummaryInfo> - Parameters:
definition
- the definition holding information for the PRODUCTtaskID
- the ID of the task the definition belongs or will belong to, for optional use. Can be null if the operation is done for a non-saved task.- Returns:
- a new PRODUCT
-
getInformation
Returns an information object about components which can be produced with this factory.The returned info contains information about how such a component is to be presented in the taskPlanner GUI. This are display-infos or available options to configure. The returned information contains
fields
which describes the values a user can specify in the WEB GUI. The field is also responsible to replace any placeholders for the corresponding property in aserial
task. That means properties without a field definition will not get any series placeholder replaced.If you implement a factory for a component only to be used by API, only then you can return null here.
- Specified by:
getInformation
in classAbstractFactory<com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTrigger,
TriggerDefinition, TriggerInfo, SummaryInfo> - Parameters:
taskID
- the ID of the task the definition belongs or will belong to, for optional use. Can be null if the operation is done for a non-saved task.- Returns:
- an information object for components this factory can produce
-
validate
public void validate(@Nonnull @Nonnull TriggerDefinition definition, com.inet.id.GUID taskID) throws ValidationException Validate the given definition.The given definition is guaranteed to belong to this factory
- Specified by:
validate
in classSeriesIndependentFactory<com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTrigger,
TriggerDefinition, TriggerInfo, SummaryInfo> - Parameters:
definition
- the definition to validatetaskID
- the ID of the task the definition belongs or will belong to, for optional use. Can be null if the operation is done for a non-saved task.- Throws:
ValidationException
- if the component has some errors
-
getSummary
Construct Summary infos for the component represented by given definition.The summary info is used when the webgui displays the component.
When implementing a factory for a component only to be used per API, only then you can return null here.
- Specified by:
getSummary
in classAbstractFactory<com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTrigger,
TriggerDefinition, TriggerInfo, SummaryInfo> - Parameters:
definition
- the definition with the settings made by a user- Returns:
- summary infos containing text lines to be displayed in the webgui for this component.
-
isAvailable
public boolean isAvailable()Whether the (COMPONENT) is available or not.- Overrides:
isAvailable
in classAbstractFactory<com.inet.taskplanner.server.api.trigger.lowmemory.LowMemoryTrigger,
TriggerDefinition, TriggerInfo, SummaryInfo> - Returns:
- whether the (COMPONENT) is available or not
-