com.ibm.commerce.payment.event

Class RefundEventData

  • Direct Known Subclasses:
    FinalizeRefundEventData


    public class RefundEventData
    extends BaseEventData
    This class is the Base class of refund specific event data in payment rules. It represents the common attributes of all refund event data in payment rules when refund business event occurs. After the task command decides what refund 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
      RefundEventData() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      org.eclipse.hyades.logging.events.cbe.ExtendedDataElement composeEventEDE()
      This method composes the common attributes of refund event data 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 RefundEventData object.
      RefundActionData getActionData(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement edeActionData)
      This method gets the original action data from ExtendedDataElement .
      java.util.HashMap getActionDataLists(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
      This method gets the original HashMap object from ExtendedDataElement .
      java.lang.String getCurrency()
      This method gets the current currency.
      org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDEActionData(RefundActionData actionData)
      This method gets the ExtendedDataElement object from the RefundActionData
      org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDEActionDataLists(java.util.HashMap actionDataLists, java.lang.String name)
      This method gets the ExtendedDataElement from a HashMap object.
      org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDERefundSensitiveInfo(java.util.Map mapOfSensitiveInfo)
      This method gets the ExtendedDataElement that corresponds to the Map.
      java.util.HashMap getHashOfActionDetailLists()
      This method gets the HashMap object that contains the action list for each refund instruction.
      java.util.Map getRefundSensitiveInfo()
      This method gets the refund sensitive information.
      java.util.Map getRefundSensitiveInfo(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
      This method gets the Map with sensitive info from ExtendedDataElement.
      java.lang.Long getRmaId()
      This method gets the current RMA id, and the refund event is associated with RMA.
      void setCurrency(java.lang.String string)
      This method sets the current currency.
      void setHashOfActionDetailLists(java.util.HashMap map)
      This method sets HashMap object that contains the action list for each refund instruction.
      void setRefundSensitiveInfo(java.util.Map localMapOfRefundSensitiveInfo)
      This method sets the refund sensitive information.
      void setRmaId(java.lang.Long long1)
      This method sets the current RMA id, and the refund event is associated with RMA.
      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

      • RefundEventData

        public RefundEventData()
    • Method Detail

      • composeEventEDE

        public org.eclipse.hyades.logging.events.cbe.ExtendedDataElement composeEventEDE()
        This method composes the common attributes of refund event data to ExtendedDataElement which is for the data format Event using. Before the corresponding task command raises the refund event, it firstly calls this method to compose the data to the data format event infrastructure needs.
        Overrides:
        composeEventEDE in class BaseEventData
        Returns:
        ExtendedDataElement The composed ExtendedDataElement
      • 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 RefundEventData object. It is called by this classs's subclass to first decompose ExtendedDataElement to get common attributes in refund rules when refund business event occurs.
        Overrides:
        decomposeEventEDE in class BaseEventData
        Parameters:
        ede - The ExtendedDataElement to decompose
        Throws:
        ECException - In case of failure
      • getEDEActionDataLists

        public org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDEActionDataLists(java.util.HashMap actionDataLists,
                                                                                               java.lang.String name)
        This method gets the ExtendedDataElement from a HashMap object.
        Parameters:
        actionDataLists - The HashMap that stores the action data lists
        name - The ExtendedDataElement name
        Returns:
        ExtentedDataElment returned ExtendedDataElement
      • getActionDataLists

        public java.util.HashMap getActionDataLists(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
                                             throws ECException
        This method gets the original HashMap object from ExtendedDataElement .
        Parameters:
        ede - The ExtendedDataElement object
        Returns:
        HashMap The original HashMap object
        Throws:
        ECException - In case of any failures
      • getEDEActionData

        public org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDEActionData(RefundActionData actionData)
        This method gets the ExtendedDataElement object from the RefundActionData
        Parameters:
        actionData - The refund action data
        Returns:
        ExtendedDataElement The returned ExtendedDataElement
      • getActionData

        public RefundActionData getActionData(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement edeActionData)
                                       throws ECException
        This method gets the original action data from ExtendedDataElement .
        Parameters:
        edeActionData - The ExtendedDataElement for action data
        Returns:
        RefundActionData The original action data
        Throws:
        ECException - In case of any failures
      • getHashOfActionDetailLists

        public java.util.HashMap getHashOfActionDetailLists()
        This method gets the HashMap object that contains the action list for each refund instruction.
        Returns:
        HashMap The returned HashMap that contains the action list for each refund instruction
      • setHashOfActionDetailLists

        public void setHashOfActionDetailLists(java.util.HashMap map)
        This method sets HashMap object that contains the action list for each refund instruction.
        Parameters:
        map - The HashMap that contains the action list for each refund instruction
      • getCurrency

        public java.lang.String getCurrency()
        This method gets the current currency.
        Returns:
        currency The current currency
      • getRmaId

        public java.lang.Long getRmaId()
        This method gets the current RMA id, and the refund event is associated with RMA.
        Returns:
        rmaId The current RMA id
      • setCurrency

        public void setCurrency(java.lang.String string)
        This method sets the current currency.
        Parameters:
        string - The current currency
      • setRmaId

        public void setRmaId(java.lang.Long long1)
        This method sets the current RMA id, and the refund event is associated with RMA.
        Parameters:
        long1 - The current RMA id
      • toString

        public java.lang.String toString()
        This method converts the attributes of this class to a human-readable format.
        Overrides:
        toString in class BaseEventData
        Returns:
        String
      • getRefundSensitiveInfo

        public java.util.Map getRefundSensitiveInfo()
        This method gets the refund sensitive information.
        Returns:
        The refund sensitive information
      • setRefundSensitiveInfo

        public void setRefundSensitiveInfo(java.util.Map localMapOfRefundSensitiveInfo)
        This method sets the refund sensitive information.
        Parameters:
        localMapOfRefundSensitiveInfo - The refund sensitive information.
      • getEDERefundSensitiveInfo

        public org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDERefundSensitiveInfo(java.util.Map mapOfSensitiveInfo)
        This method gets the ExtendedDataElement that corresponds to the Map. This Map contains the sensitive refund information.
        Parameters:
        mapOfSensitiveInfo - All of the sensitive information stored in a Map.
        Returns:
        The ExtendedDataElement.
      • getRefundSensitiveInfo

        public java.util.Map getRefundSensitiveInfo(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
        This method gets the Map with sensitive info from ExtendedDataElement.
        Parameters:
        ede - The current ExtendedDataElement.
        Returns:
        The Map got from current ExtendedDataElement.