Interface ScriptRunRequest


  • public interface ScriptRunRequest
    This is a request to the ScriptRuntimeEngine. The arguments are sent along in a map which is returned with their updated values. An getAction() is supplied which tells the runtime engine about script to run. This is agreed on by the implementors and can be a key or perhaps the name of a script.

    Created by Jeff Gaynor
    on 2/6/20 at 12:28 PM

    • Method Detail

      • getArgs

        Map<String,​Object> getArgs()
        The arguments for the script. Each name should be turned in to a variable that the script can understand.
        Returns:
      • getAction

        String getAction()
        An action for the script engine to do. These are set based on the application/implementor and the specific underlying language.
        Returns:
      • returnArgs

        boolean returnArgs()
        Return the supplied arguments, using their same names along with any response.
        Returns:
      • getResponseArgName

        String getResponseArgName()
        The name of the response, if any, to be returned.
        Returns:
      • hasReturnedValue

        boolean hasReturnedValue()
        Whether or not this returns a value. If not, then the response argument name is ignored. This may be the case if the script has no output.
        Returns: