com.ibm.commerce.payment.event

Class BaseEventData

  • java.lang.Object
    • com.ibm.commerce.payment.event.BaseEventData
  • Direct Known Subclasses:
    PaymentEventData, RefundEventData

    public class BaseEventData
extends java.lang.Object
    This class is the Base class of event data in payment rules, which represents the common attributes of all payment rules event data. After the task command decides what payment actions should be executed, it raises the payment rules event into the event bus with this event data.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.

    • Constructor Summary

      Constructors 
      Constructor and Description
      BaseEventData() 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      org.eclipse.hyades.logging.events.cbe.ExtendedDataElement composeEventEDE()
      This method is to compose this BaseEventData to ExtendedDataElement which is for the data format Event using.
      void decomposeEventEDE(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
      This method is to decompose this ExtendedDataElement which is the data format Event using to BaseEventData object.
      java.util.Locale getLocale()
      This method gets current locale.
      java.lang.String getOrderChannel()
      This method gets the current order channel.
      java.lang.Integer getStoreId()
      This method gets the current store id.
      void setLocale(java.util.Locale localLocale)
      This method sets the current locale.
      void setOrderChannel(java.lang.String string)
      This method sets the current order channel.
      void setStoreId(java.lang.Integer integer)
      This method sets the current store id.
      java.lang.String toString()
      This method converts the attributes of this class to a human-readable format.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • BaseEventData

        public BaseEventData()

    • Method Detail

      • composeEventEDE

        public org.eclipse.hyades.logging.events.cbe.ExtendedDataElement composeEventEDE()
        This method is to compose this BaseEventData to ExtendedDataElement which is for the data format Event using. It is called by this classs's subclass to first get ExtendedDataElement for common attributes in payment rules.
        Returns:
        ExtendedDataElement the ExtendedDataElement of BaseEventData object.

      • decomposeEventEDE

        public void decomposeEventEDE(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
                       throws ECException
        This method is to decompose this ExtendedDataElement which is the data format Event using to BaseEventData object. It is called by this classs's subclass to first decompose ExtendedDataElement to get common attributes in payment rules.
        Parameters:
        ede - the event data format
        Throws:
        ECException - In case of failure

      • getLocale

        public java.util.Locale getLocale()
        This method gets current locale.
        Returns:
        locale The current locale

      • getOrderChannel

        public java.lang.String getOrderChannel()
        This method gets the current order channel.
        Returns:
        orderChannel The current order channel

      • getStoreId

        public java.lang.Integer getStoreId()
        This method gets the current store id.
        Returns:
        storeId The current store id

      • setLocale

        public void setLocale(java.util.Locale localLocale)
        This method sets the current locale.
        Parameters:
        localLocale - The current locale

      • setOrderChannel

        public void setOrderChannel(java.lang.String string)
        This method sets the current order channel.
        Parameters:
        string - The current order channel

      • setStoreId

        public void setStoreId(java.lang.Integer integer)
        This method sets the current store id.
        Parameters:
        integer - The current store id

      • toString

        public java.lang.String toString()
        This method converts the attributes of this class to a human-readable format.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String
Skip navigation links