Class PluginRequest<P extends Plugin>

    • Method Detail

      • getSessionControl

        public SessionControl getSessionControl()
        Returns:
        The SessionControl used in this request
        Since:
        2.11
      • getCommand

        public String getCommand()
        Get the command this request will issue to the plugin when invoke() is called.
      • setParameterValues

        public void setParameterValues​(String name,
                                       List<?> values)
        Set the value of a request parameter to a list of values. Normally a plugin validates the value using the information available in the RequestInformation object.
        Parameters:
        name - The name of the parameter
        values - The values of the parameter
        See Also:
        PluginConfigurationRequest.getRequestInformation()
      • getCurrentParameterValue

        public Object getCurrentParameterValue​(String name)
      • getCurrentParameterValues

        public List<?> getCurrentParameterValues​(String name)
        Get the values that are currently stored in the job or plugin configuration related to this request. This method will first check the job and then the plugin configuration.
        Parameters:
        name - The name of the parameter
        Returns:
        The parameter values, or null if no parameter with the given name exists
      • getCurrentConfigurationParameterValues

        public List<?> getCurrentConfigurationParameterValues​(String name)
        Get the values that are currently stored in the plugin configuration related to this request.
        Parameters:
        name - The name of the parameter
        Returns:
        The parameter values, or null if no parameter with the given name exists or if this request isn't associated with a plugin configuration
      • getCurrentJobParameterValues

        public List<?> getCurrentJobParameterValues​(String name)
        Get the values that are currently stored in the job related to this request.
        Parameters:
        name - The name of the parameter
        Returns:
        The parameter values, or null if no parameter with the given name exists or if this request isn't associated with a job
      • done

        public void done()
        Aborts the execution of the plugin.
      • saveParameters

        void saveParameters​(DbControl dc,
                            GuiContext context)
        Save all parameters that have got values in this request/response session.
      • setNextCommand

        void setNextCommand​(String command)
        Sets the next command in a configuration sequence.
      • getPlugin

        public P getPlugin()
        Get the plugin object.
        Since:
        2.6 (was not public before)
      • getJob

        Job getJob()
        Get the job for the request or null if we are not configuring/executing a job.
        Since:
        2.2