Package org.apache.ofbiz.common.scripting

Class ScriptHelperImpl

  • All Implemented Interfaces:
    ScriptHelper
    public final class ScriptHelperImpl
extends java.lang.Object
implements ScriptHelper
    An implementation of the ScriptHelper interface.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String module  

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptHelperImpl​(javax.script.ScriptContext context)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​? extends java.lang.Object> createServiceMap​(java.lang.String serviceName, java.util.Map<java.lang.String,​? extends java.lang.Object> inputMap)
      Extracts service IN parameters from inputMap and returns them in a new Map.
      void error​(java.lang.String message)
      Sets the event/service status to error status.
      java.lang.String evalString​(java.lang.String original)
      Evaluates a String and returns the result.
      void failure​(java.lang.String message)
      Sets the event/service status to failure status.
      java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> findList​(java.lang.String entityName, java.util.Map<java.lang.String,​? extends java.lang.Object> fields)
      Returns a List of GenericValues.
      java.util.Map<java.lang.String,​java.lang.Object> findOne​(java.lang.String entityName)
      Finds a GenericValue by primary key.
      java.util.Map<java.lang.String,​java.lang.Object> findOne​(java.lang.String entityName, java.util.Map<java.lang.String,​? extends java.lang.Object> fields, java.util.Map<java.lang.String,​? extends java.lang.Object> args)
      Finds a GenericValue by primary key.
      void logError​(java.lang.String message)
      Logs an error message.
      void logInfo​(java.lang.String message)
      Logs an info message.
      void logWarning​(java.lang.String message)
      Logs a warning message.
      java.util.Map<java.lang.String,​java.lang.Object> makeValue​(java.lang.String entityName)
      Creates a new, empty GenericValue.
      java.util.Map<java.lang.String,​java.lang.Object> makeValue​(java.lang.String entityName, java.util.Map<java.lang.String,​java.lang.Object> fields)
      Creates a new, empty GenericValue.
      java.util.Map<java.lang.String,​? extends java.lang.Object> runService​(java.lang.String serviceName, java.util.Map<java.lang.String,​? extends java.lang.Object> inputMap)
      Runs a service synchronously.
      java.util.Map<java.lang.String,​? extends java.lang.Object> runService​(java.lang.String serviceName, java.util.Map<java.lang.String,​? extends java.lang.Object> inputMap, java.util.Map<java.lang.String,​? extends java.lang.Object> args)
      Runs a service synchronously.
      void success()
      Sets the event/service status to success status.
      void success​(java.lang.String message)
      Sets the event/service status to success status.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • module

        public static final java.lang.String module

    • Constructor Detail

      • ScriptHelperImpl

        public ScriptHelperImpl​(javax.script.ScriptContext context)

    • Method Detail

      • createServiceMap

        public java.util.Map<java.lang.String,​? extends java.lang.Object> createServiceMap​(java.lang.String serviceName,
                                                                                         java.util.Map<java.lang.String,​? extends java.lang.Object> inputMap)
                                                                                  throws javax.script.ScriptException
        Description copied from interface: ScriptHelper
        Extracts service IN parameters from inputMap and returns them in a new Map.
        Specified by:
        createServiceMap in interface ScriptHelper
        Returns:
        The matching service parameters
        Throws:
        javax.script.ScriptException

      • error

        public void error​(java.lang.String message)
        Description copied from interface: ScriptHelper
        Sets the event/service status to error status.
        Specified by:
        error in interface ScriptHelper

      • evalString

        public java.lang.String evalString​(java.lang.String original)
        Description copied from interface: ScriptHelper
        Evaluates a String and returns the result.
        Specified by:
        evalString in interface ScriptHelper
        Returns:

      • failure

        public void failure​(java.lang.String message)
        Description copied from interface: ScriptHelper
        Sets the event/service status to failure status.
        Specified by:
        failure in interface ScriptHelper

      • findList

        public java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> findList​(java.lang.String entityName,
                                                                                       java.util.Map<java.lang.String,​? extends java.lang.Object> fields)
                                                                                throws javax.script.ScriptException
        Description copied from interface: ScriptHelper
        Returns a List of GenericValues.
        Specified by:
        findList in interface ScriptHelper
        Returns:
        Throws:
        javax.script.ScriptException

      • findOne

        public java.util.Map<java.lang.String,​java.lang.Object> findOne​(java.lang.String entityName)
                                                               throws javax.script.ScriptException
        Description copied from interface: ScriptHelper
        Finds a GenericValue by primary key. The helper will construct a primary key from existing variables.
        Specified by:
        findOne in interface ScriptHelper
        Returns:
        Throws:
        javax.script.ScriptException

      • findOne

        public java.util.Map<java.lang.String,​java.lang.Object> findOne​(java.lang.String entityName,
                                                                      java.util.Map<java.lang.String,​? extends java.lang.Object> fields,
                                                                      java.util.Map<java.lang.String,​? extends java.lang.Object> args)
                                                               throws javax.script.ScriptException
        Description copied from interface: ScriptHelper
        Finds a GenericValue by primary key. The helper will construct a primary key from existing variables and/or fields.
        Specified by:
        findOne in interface ScriptHelper
        Returns:
        Throws:
        javax.script.ScriptException

      • logError

        public void logError​(java.lang.String message)
        Description copied from interface: ScriptHelper
        Logs an error message.
        Specified by:
        logError in interface ScriptHelper

      • logInfo

        public void logInfo​(java.lang.String message)
        Description copied from interface: ScriptHelper
        Logs an info message.
        Specified by:
        logInfo in interface ScriptHelper

      • logWarning

        public void logWarning​(java.lang.String message)
        Description copied from interface: ScriptHelper
        Logs a warning message.
        Specified by:
        logWarning in interface ScriptHelper

      • makeValue

        public java.util.Map<java.lang.String,​java.lang.Object> makeValue​(java.lang.String entityName)
                                                                 throws javax.script.ScriptException
        Description copied from interface: ScriptHelper
        Creates a new, empty GenericValue.
        Specified by:
        makeValue in interface ScriptHelper
        Returns:
        Throws:
        javax.script.ScriptException

      • makeValue

        public java.util.Map<java.lang.String,​java.lang.Object> makeValue​(java.lang.String entityName,
                                                                        java.util.Map<java.lang.String,​java.lang.Object> fields)
                                                                 throws javax.script.ScriptException
        Description copied from interface: ScriptHelper
        Creates a new, empty GenericValue.
        Specified by:
        makeValue in interface ScriptHelper
        Returns:
        Throws:
        javax.script.ScriptException

      • runService

        public java.util.Map<java.lang.String,​? extends java.lang.Object> runService​(java.lang.String serviceName,
                                                                                   java.util.Map<java.lang.String,​? extends java.lang.Object> inputMap)
                                                                            throws javax.script.ScriptException
        Description copied from interface: ScriptHelper
        Runs a service synchronously.
        Specified by:
        runService in interface ScriptHelper
        Returns:
        Throws:
        javax.script.ScriptException

      • runService

        public java.util.Map<java.lang.String,​? extends java.lang.Object> runService​(java.lang.String serviceName,
                                                                                   java.util.Map<java.lang.String,​? extends java.lang.Object> inputMap,
                                                                                   java.util.Map<java.lang.String,​? extends java.lang.Object> args)
                                                                            throws javax.script.ScriptException
        Description copied from interface: ScriptHelper
        Runs a service synchronously.
        Specified by:
        runService in interface ScriptHelper
        Returns:
        Throws:
        javax.script.ScriptException

      • success

        public void success()
        Description copied from interface: ScriptHelper
        Sets the event/service status to success status.
        Specified by:
        success in interface ScriptHelper

      • success

        public void success​(java.lang.String message)
        Description copied from interface: ScriptHelper
        Sets the event/service status to success status.
        Specified by:
        success in interface ScriptHelper