com.ibm.commerce.foundation.server.command.bod

Class ActionExpression

  • java.lang.Object
    • com.ibm.commerce.foundation.server.command.bod.ActionExpression


  • public class ActionExpression
    extends java.lang.Object

    The action expression object represents the information that can be extracted from the ActionExpression elements of the Change, Process and Sync verbs. The ActionExpression indicates the action code of the action, an extended XPath notation to indicate the business object part of the action along with additional control parameters.

    This object represents the conversion of the ActionExpression into the object the expression points to along with the action code and control parameters. This object is passed to the change, process and sync tasks to perform the appropriate business logic based on this action information.

    • Constructor Summary

      Constructors 
      Constructor and Description
      ActionExpression()
      Creates an instance of the action expression object.
      ActionExpression(java.lang.String actionCode, java.lang.Object actionExpressionObject, java.lang.Object actionExpressionParentObject, java.lang.String actionExpressionObjectXPath, java.lang.String actionExpressionObjectXPathKey, java.util.List controlParameters)
      Creates an instance of the action expression object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getActionCode()
      This method returns the action code of the action expression.
      java.lang.Object getActionExpressionObject()
      This method returns the object pointed to in the action expression.
      java.lang.String getActionExpressionObjectXPath()
      This method returns the XPath expression which pointed to the object in the action expression.
      java.lang.Object getActionExpressionParentObject()
      This method returns the parent object pointed to in the action expression.
      java.util.List getControlParameters()
      This method returns the control parameters of the action expression.
      java.lang.String getXPathKey()
      This method returns the XPath normalized key which pointed to the object in the action expression.
      void setActionCode(java.lang.String actionCode)
      This method sets the action code of that action expression.
      void setActionExpressionObject(java.lang.Object actionExpressionObject)
      This method sets the object of the action expression.
      void setActionExpressionObjectXPath(java.lang.String actionExpressionObjectXPath)
      This method sets the XPath expression pointing to the object of the action expression.
      void setActionExpressionParentObject(java.lang.Object actionExpressionParentObject)
      This method sets the parent object of the action expression.
      void setControlParameters(java.util.List controlParameters)
      This method sets the control parameters of the action expression.
      void setXPathKey(java.lang.String actionExpressionObjectXPathKey)
      This method sets the XPath normalized key pointing to the object of the action expression.
      java.lang.String toString()
      This method returns the string representation of the object instance for debugging purposes.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ActionExpression

        public ActionExpression()
        Creates an instance of the action expression object.
      • ActionExpression

        public ActionExpression(java.lang.String actionCode,
                                java.lang.Object actionExpressionObject,
                                java.lang.Object actionExpressionParentObject,
                                java.lang.String actionExpressionObjectXPath,
                                java.lang.String actionExpressionObjectXPathKey,
                                java.util.List controlParameters)
        Creates an instance of the action expression object.
        Parameters:
        actionCode - The action code of the action expression.
        actionExpressionObject - The object involved with the action.
        actionExpressionParentObject - The parent object involved with the action.
        actionExpressionObjectXPath - The XPath expression pointing to the object.
        actionExpressionObjectXPathKey - The normalized for of the XPath which represents a consistent key.
        controlParameters - The control parameters associated with the action.
    • Method Detail

      • getActionCode

        public java.lang.String getActionCode()
        This method returns the action code of the action expression.
        Returns:
        The action code.
      • setActionCode

        public void setActionCode(java.lang.String actionCode)
        This method sets the action code of that action expression.
        Parameters:
        actionCode - The action code.
      • getActionExpressionObject

        public java.lang.Object getActionExpressionObject()
        This method returns the object pointed to in the action expression.
        Returns:
        The action expression object.
      • setActionExpressionObject

        public void setActionExpressionObject(java.lang.Object actionExpressionObject)
        This method sets the object of the action expression.
        Parameters:
        actionExpressionObject - The action expression object.
      • getActionExpressionParentObject

        public java.lang.Object getActionExpressionParentObject()
        This method returns the parent object pointed to in the action expression.
        Returns:
        The action expression parent object.
      • setActionExpressionParentObject

        public void setActionExpressionParentObject(java.lang.Object actionExpressionParentObject)
        This method sets the parent object of the action expression.
        Parameters:
        actionExpressionParentObject - The action expression parent object.
      • getActionExpressionObjectXPath

        public java.lang.String getActionExpressionObjectXPath()
        This method returns the XPath expression which pointed to the object in the action expression.
        Returns:
        The action expression object XPath expression.
      • setActionExpressionObjectXPath

        public void setActionExpressionObjectXPath(java.lang.String actionExpressionObjectXPath)
        This method sets the XPath expression pointing to the object of the action expression.
        Parameters:
        actionExpressionObjectXPath - The action expression object XPath expression.
      • getXPathKey

        public java.lang.String getXPathKey()
        This method returns the XPath normalized key which pointed to the object in the action expression.
        Returns:
        The action expression object XPath expression.
      • setXPathKey

        public void setXPathKey(java.lang.String actionExpressionObjectXPathKey)
        This method sets the XPath normalized key pointing to the object of the action expression.
        Parameters:
        actionExpressionObjectXPathKey - The action expression object XPath expression.
      • getControlParameters

        public java.util.List getControlParameters()
        This method returns the control parameters of the action expression.
        Returns:
        The action expression control parameters.
      • setControlParameters

        public void setControlParameters(java.util.List controlParameters)
        This method sets the control parameters of the action expression.
        Parameters:
        controlParameters - The action expression control parameters.
      • toString

        public java.lang.String toString()
        This method returns the string representation of the object instance for debugging purposes.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string representation of the object.