com.ibm.commerce.payment.event

Class PaymentEventData

    • Field Summary

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

      Constructors 
      Constructor and Description
      PaymentEventData() 
    • 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 payment 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 PaymentEventData object.
      PaymentActionData getActionData(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement edeActionData)
      This method gets current action data from the ExtendedDataElement.
      java.util.HashMap getActionDataLists(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
      This method gets the HashMap from ExtendedDataElement.
      java.util.ArrayList getArrayList(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement edeArrayList)
      This method gets the ArrayList from an ExtendedDataElement.
      org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDEActionData(PaymentActionData actionData)
      This method gets the ExtendedDataElement from current payment action data.
      org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDEActionDataLists(java.util.HashMap actionDataLists, java.lang.String name)
      This method gets the ExtendedDataElement that corresponds to the HashMap.
      org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDEArrayList(java.util.ArrayList apsReversal)
      This method gets the ExtendedDataElement from the reversal ArrayList.
      org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDERelBwtRlsAndPay(java.util.HashMap relationshipBwtRlsAndPayment, java.lang.String name)
      This method gets the ExtendedDataElement that corresponds to the HashMap.
      java.lang.Long getEDPOrderId()
      This method gets the current EDP order Id, and the corresponding EDP order stores the necessary order information needed by payment rules.
      java.util.HashMap getHashOfActionDetailLists()
      This method gets the action detailed lists stored in a HashMap.
      java.util.HashMap getHashOfEditActionDetailLists()
      This method gets the edit action detailed lists stored in a HashMap.
      java.util.HashMap getHashOfReversalActionDetailLists()
      This method gets the reversal action detailed lists stored in a HashMap.
      java.lang.Long getOrderId()
      This method gets current order id.
      java.util.HashMap getRelationBwtRlsAndPay(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
      This method gets the HashMap from ExtendedDataElement.
      java.util.HashMap getRelationOfRlsAndPay()
      This method returns the relationship between release and payments.
      int getStatus()
      This method gets current status of EDP order that indicates the backend payment status of current EDP order is in open/successful/working/failed.
      boolean isIdempotent()
      This method gets if it is idempotent .
      void setEDPOrderId(java.lang.Long long1)
      This method gets current EDP order Id, and the corresponding EDP order stores the necessary order information needed by payment rules.
      void setHashOfActionDetailLists(java.util.HashMap map)
      This method sets the reversal action detailed lists to a HashMap.
      void setHashOfEditActionDetailLists(java.util.HashMap map)
      This method sets the edit action detailed lists to a HashMap.
      void setHashOfReversalActionDetailLists(java.util.HashMap map)
      This method sets the reversal action detailed lists to a HashMap.
      void setIdempotent(boolean b)
      This method sets if it is idempotent .
      void setOrderId(java.lang.Long long1)
      This method sets current order id.
      void setRelationOfRlsAndPay(java.util.HashMap relationOfReleaseAndPay)
      This method sets the relationship between release and payments.
      void setStatus(int i)
      This method sets current status of EDP order that indicates the backend payment status of current EDP order is in open/successful/working/failed.
      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

      • PaymentEventData

        public PaymentEventData()
    • Method Detail

      • composeEventEDE

        public org.eclipse.hyades.logging.events.cbe.ExtendedDataElement composeEventEDE()
        This method composes the common attributes of payment event data to ExtendedDataElement which is for the data format Event using. Before the corresponding task command raises the payment event, it firstly calls this method to compose the data to the data format event infrastructure needs. Note that you should avoid to have two reverseApprovalAction against same atomic payment object For example, if A PI has atomic payment in ApprovedState , a payment instruction change asks decrease payment instruction amount and change payment instruction protocol data, this could cause two actions against same atomic payment.
        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 PaymentEventData object. It is called by this classs's subclass to first decompose ExtendedDataElement to get common attributes in payment rules when payment 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 that corresponds to the HashMap.
        Parameters:
        actionDataLists - The lists for action data stored in a HashMap
        name - The ExtendedDataElement name
        Returns:
        ExtendedDataElement
      • getEDERelBwtRlsAndPay

        public org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDERelBwtRlsAndPay(java.util.HashMap relationshipBwtRlsAndPayment,
                                                                                               java.lang.String name)
        This method gets the ExtendedDataElement that corresponds to the HashMap.
        Parameters:
        relationshipBwtRlsAndPayment - The lists for action data stored in a HashMap
        name - The ExtendedDataElement name
        Returns:
        ExtendedDataElement
      • getRelationBwtRlsAndPay

        public java.util.HashMap getRelationBwtRlsAndPay(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
        This method gets the HashMap from ExtendedDataElement.
        Parameters:
        ede - The current ExtendedDataElement
        Returns:
        HashMap The returned HashMap from current ExtendedDataElement
      • getActionDataLists

        public java.util.HashMap getActionDataLists(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement ede)
        This method gets the HashMap from ExtendedDataElement.
        Parameters:
        ede - The current ExtendedDataElement
        Returns:
        HashMap The returned HashMap from current ExtendedDataElement
      • getEDEArrayList

        public org.eclipse.hyades.logging.events.cbe.ExtendedDataElement getEDEArrayList(java.util.ArrayList apsReversal)
        This method gets the ExtendedDataElement from the reversal ArrayList.
        Parameters:
        apsReversal - The arraylist for atomic payments reversal.
        Returns:
        ExtendedDataElement The returned ExtendedDataElement
      • getArrayList

        public java.util.ArrayList getArrayList(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement edeArrayList)
        This method gets the ArrayList from an ExtendedDataElement.
        Parameters:
        edeArrayList - The current ExtendedDataElement
        Returns:
        ArrayList The returned ArrayList
      • getEDEActionData

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

        public PaymentActionData getActionData(org.eclipse.hyades.logging.events.cbe.ExtendedDataElement edeActionData)
        This method gets current action data from the ExtendedDataElement.
        Parameters:
        edeActionData - The current ExtendedDataElement
        Returns:
        PaymentActionData The returned Payment Action Data
      • getHashOfActionDetailLists

        public java.util.HashMap getHashOfActionDetailLists()
        This method gets the action detailed lists stored in a HashMap. And each name value pair in this HashMap includes the payment instruction id and the payment action list of this payment instruction.
        Returns:
        HashMap The returned HashMap
      • getHashOfEditActionDetailLists

        public java.util.HashMap getHashOfEditActionDetailLists()
        This method gets the edit action detailed lists stored in a HashMap. And each name value pair in this HashMap includes the payment instruction id and the edit action list of this payment instruction.
        Returns:
        HashMap The returned HashMap
      • getHashOfReversalActionDetailLists

        public java.util.HashMap getHashOfReversalActionDetailLists()
        This method gets the reversal action detailed lists stored in a HashMap. And each name value pair in this HashMap includes the payment instruction id and the reversal action list of this payment instruction.
        Returns:
        HashMap The returned HashMap
      • setHashOfActionDetailLists

        public void setHashOfActionDetailLists(java.util.HashMap map)
        This method sets the reversal action detailed lists to a HashMap. And each name value pair in this HashMap includes the payment instruction id and the payment action list of this payment instruction.
        Parameters:
        map - The current HashMap
      • setHashOfEditActionDetailLists

        public void setHashOfEditActionDetailLists(java.util.HashMap map)
        This method sets the edit action detailed lists to a HashMap. And each name value pair in this HashMap includes the payment instruction id and the edit action list of this payment instruction.
        Parameters:
        map - The current HashMap
      • setHashOfReversalActionDetailLists

        public void setHashOfReversalActionDetailLists(java.util.HashMap map)
        This method sets the reversal action detailed lists to a HashMap. And each name value pair in this HashMap includes the payment instruction id and the reversal action list of this payment instruction.
        Parameters:
        map - The current HashMap
      • getEDPOrderId

        public java.lang.Long getEDPOrderId()
        This method gets the current EDP order Id, and the corresponding EDP order stores the necessary order information needed by payment rules.
        Returns:
        edpOrderId The current EDP order id
      • isIdempotent

        public boolean isIdempotent()
        This method gets if it is idempotent .
        Returns:
        idempotent If it is idempotent
      • getOrderId

        public java.lang.Long getOrderId()
        This method gets current order id.
        Returns:
        orderId The current order id
      • getStatus

        public int getStatus()
        This method gets current status of EDP order that indicates the backend payment status of current EDP order is in open/successful/working/failed.
        Returns:
        status The current status
      • setEDPOrderId

        public void setEDPOrderId(java.lang.Long long1)
        This method gets current EDP order Id, and the corresponding EDP order stores the necessary order information needed by payment rules.
        Parameters:
        long1 - The current EDP order id
      • setIdempotent

        public void setIdempotent(boolean b)
        This method sets if it is idempotent .
        Parameters:
        b - If it is idempotent
      • setOrderId

        public void setOrderId(java.lang.Long long1)
        This method sets current order id.
        Parameters:
        long1 - The current order id
      • setStatus

        public void setStatus(int i)
        This method sets current status of EDP order that indicates the backend payment status of current EDP order is in open/successful/working/failed.
        Parameters:
        i - The current status
      • getRelationOfRlsAndPay

        public java.util.HashMap getRelationOfRlsAndPay()
        This method returns the relationship between release and payments.
        Returns:
        Returns the relationship between release and payments.
      • setRelationOfRlsAndPay

        public void setRelationOfRlsAndPay(java.util.HashMap relationOfReleaseAndPay)
        This method sets the relationship between release and payments.
        Parameters:
        relationOfReleaseAndPay - the relationship between release and payments.
      • 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