Class HelpImporter

    • Constructor Detail

      • HelpImporter

        public HelpImporter()
    • Method Detail

      • getGuiContexts

        public Set<GuiContext> getGuiContexts()
        Description copied from interface: InteractivePlugin
        Get a set containing all items that the plugin handles. Ie. if the plugin imports reporters, return a set containing Item.REPORTER. This information is used by client applications to put the plugin in the proper place in the user interface.
        Specified by:
        getGuiContexts in interface InteractivePlugin
        Returns:
        A Set containing Item:s, or null if the plugin is not concerned about items
      • isInContext

        public String isInContext​(GuiContext context,
                                  Object item)
        Description copied from interface: InteractivePlugin
        Check if the plugin can be used on the specified object. The item is either a BasicItem or BasicData object, or null if called from a list context. A client application should only call this method for contexts matching one of the contexts in the set returned by the InteractivePlugin.getGuiContexts() method. For GuiContext.Type.ITEM contexts an item of the correct type should be passed as a parameter.

        The plug-in can response with a null value indicating success, a warning-level message or throw an exception to indicate an error-level message. Client application should normally only show error-level messages to users, unless the user has requested to see warning messages.

        NOTE! Before BASE 2.4 all messages were treated as error-level messages.

        Specified by:
        isInContext in interface InteractivePlugin
        Parameters:
        context - The current context of the client application, it is one of the values found in set returned by InteractivePlugin.getGuiContexts()
        item - The currently active item, it's type should match the GuiContext.getItem() type, or null if the context is a list context
        Returns:
        Null if the plugin can use that item, or a warning-level message explaining why the plugin can't be used
      • getMainType

        public Plugin.MainType getMainType()
        Description copied from interface: Plugin
        Get the type of the plugin. This method must always return the same value.
        Specified by:
        getMainType in interface Plugin
        Returns:
        One of the defined types
      • run

        public void run​(Request request,
                        Response response,
                        ProgressReporter progress)
        Description copied from interface: Plugin
        Run the plugin. If a progress reporter object is passed it is recommended that the plugin makes use of it.
        Specified by:
        run in interface Plugin
        Parameters:
        request - Request object with the command and parameters
        response - Response object in for the plugin to response through
        progress - A ProgressReporter where the plugin can report its progess, can be null
      • getSignalHandler

        public SignalHandler getSignalHandler()
        Description copied from interface: SignalTarget
        Get the signal handler that is handling signals on behalf of this object. Multiple invokations of this method may receive the same or different objects. Null may be returned if, for some reason, the current object instance doesn't want to receive signals. Returning null is the same as not implementing this interface.
        Specified by:
        getSignalHandler in interface SignalTarget
        Returns:
        A SignalHandler object, or null if the current instance doesn't support signals
      • installHelpTexts

        public void installHelpTexts​(Client client,
                                     boolean overwrite,
                                     InputStream is,
                                     String filename)
        This method installs the helptexts from an inputstream.
        Parameters:
        client - The client that owns the helptexts
        overwrite - Handles duplicate of externalID. True - the existing texts in database will be overwritten with the one from importfile that have same externalID. False - the existing texts in database are not overwritten with the one from importfile that have the same externalID.
        is - InputStream from the xml-file with texts to import
        filename - The filename of the original file or null if not known
        Since:
        2.4
      • getSuccessMessage

        private String getSuccessMessage()