Class ServerStartTriggerFactory

  • All Implemented Interfaces:
    com.inet.plugin.NamedExtension

    public class ServerStartTriggerFactory
    extends TriggerFactory<com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTrigger>
    Factory for ServerStartTriggers.
    Since:
    taskplanner 3.0
    • Field Detail

      • EXTENSION_NAME

        public static final java.lang.String EXTENSION_NAME
        Name of the serverstart trigger extension
        See Also:
        Constant Field Values
    • Constructor Detail

      • ServerStartTriggerFactory

        public ServerStartTriggerFactory()
        Creates the factory for Server Start triggers.
        Since:
        taskplanner 3.0
    • Method Detail

      • createInstanceFrom

        protected com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTrigger createInstanceFrom​(TriggerDefinition definition,
                                                                                                            com.inet.id.GUID taskID)
        Construct a component (PRODUCT) from the given definition.
        Overrides:
        createInstanceFrom in class AbstractFactory<com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTrigger,​TriggerDefinition,​TriggerInfo,​SummaryInfo>
        Parameters:
        definition - the definition holding information for the PRODUCT
        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:
        a new PRODUCT
      • getInformation

        public TriggerInfo getInformation​(com.inet.id.GUID taskID)
        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 a serial 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 class AbstractFactory<com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTrigger,​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​(TriggerDefinition triggerDefinition,
                             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 class SeriesIndependentFactory<com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTrigger,​TriggerDefinition,​TriggerInfo,​SummaryInfo>
        Parameters:
        triggerDefinition - the definition to validate
        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.
        Throws:
        ValidationException - if the component has some errors
      • getSummary

        public SummaryInfo getSummary​(TriggerDefinition definition)
        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 class AbstractFactory<com.inet.taskplanner.server.api.trigger.serverstart.ServerStartTrigger,​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.