Class EmailResultActionFactory

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

    public class EmailResultActionFactory
    extends ResultActionFactory<com.inet.taskplanner.server.api.action.email.EmailResultAction>
    A result action factory for managing the EmailResultAction settings and instances
    • Constructor Detail

      • EmailResultActionFactory

        public EmailResultActionFactory()
        Creates a instance of the factory.
        Since:
        taskplanner 3.0
    • Method Detail

      • getInformation

        public ResultActionInfo 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.action.email.EmailResultAction,​ResultActionDefinition,​ResultActionInfo,​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
      • createInstanceFrom

        protected com.inet.taskplanner.server.api.action.email.EmailResultAction createInstanceFrom​(ResultActionDefinition definition,
                                                                                                    com.inet.id.GUID taskID)
        Construct a component (PRODUCT) from the given definition.
        Overrides:
        createInstanceFrom in class AbstractFactory<com.inet.taskplanner.server.api.action.email.EmailResultAction,​ResultActionDefinition,​ResultActionInfo,​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
      • getSummary

        public SummaryInfo getSummary​(ResultActionDefinition 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.action.email.EmailResultAction,​ResultActionDefinition,​ResultActionInfo,​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.
      • getSupportedFlavors

        public java.util.List<ResultFlavor> getSupportedFlavors​(ResultActionDefinition definition)
        Returns the list of flavors, supported by this action for the given definition.
        Specified by:
        getSupportedFlavors in class ResultActionFactory<com.inet.taskplanner.server.api.action.email.EmailResultAction>
        Parameters:
        definition - the current definition settings
        Returns:
        the list of result flalvors that are currently supported according to the given definition.
      • isAutoResolvePlaceholders

        public boolean isAutoResolvePlaceholders()
        Defines whether placeholders will be automatically replaced before the handle method is called. The default implementation returns true.
        The automatic replacement will ask all fields, defined by the factory, to resolve all placeholders that match a field key and supports placeholders.

        For manual replacement, the PlaceholderResolver can be used.
        Overrides:
        isAutoResolvePlaceholders in class ResultActionFactory<com.inet.taskplanner.server.api.action.email.EmailResultAction>
        Returns:
        true if the placeholders shall be resolve automatically, false if the implementation needs to manage this by themself.