com.ibm.commerce.payment.commands

Interface UpdateTARefundCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand
    All Known Implementing Classes:
    UpdateTARefundRecordsCmdImpl

    public interface UpdateTARefundCmd
extends TaskCommand
    This task command is used to update Trading Agreement's refund amount for the given order and Return Merchandise Authorization (RMA). The default implementation of this command is UpdateTARefundRecordsCmdImpl.

    Parameters:
    Parameter Name Type Descriptions
    tradingId Long The ID of the Trading Agreement
    RMA RMAAccessBean The RMAAccessBean of the RMA
    order OrderAccessBean The OrderAccessBean of the order associated with the RMA
    refundAmount BigDecimal The Refund Amount in the currency specified in the RMA

    Assumption:
    • All return items within an RMA are against the same Trading Agreement.
    Behavior:
    • The default implementation inserts a row into the TRDREFAMT table. For this Trading ID and RMA ID ONLY if this Trading Agreement has a RightToBuy by Amount TC or ObligationToBuy by Amount TC or both.
    • Refunds may be made using a currency that is different from the currency specified for the RightToBuy by Amount TC or ObligationToBuy by Amount TC. (However, the two Terms and Conditions must have the same currency if both exist within the same Trading Agreement.)
    • The default implementation converts the refund amount to the currency specified for the RightToBuy TC or ObligationToBuy TC. And stores the converted amount in the TRDREFAMT Table. The command throws an ECApplicationException if the required currency conversion is not available or if the conversion failed.
    Error View Name:
    • UpdateTARefundErrorView
    ErrorCodes:
    See Also:
    UpdateTARefundRecordsCmdImpl

    • Field Detail

      • COPYRIGHT

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

      • NAME

        static final java.lang.String NAME
        The full name of this command.
        See Also:
        Constant Field Values

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values

      • ERRTASK_NAME

        static final java.lang.String ERRTASK_NAME
        The name of the Error View for this command. The constant value of this field is "UpdateTARefundErrorView".
        See Also:
        Constant Field Values

    • Method Detail

      • setOrder

        void setOrder(OrderAccessBean abOrder)
        This method sets the order associated with the Return Merchandise Authorization (RMA) record.
        Parameters:
        abOrder - The OrderAccessBean for the order.

      • setRefundAmount

        void setRefundAmount(java.math.BigDecimal refundAmount)
        This method sets the refundAmount property of the command.
        Parameters:
        refundAmount - A BigDecimal that specifies the amount to be refunded in the currency specified in the Return Merchandise Authorization (RMA).

      • setRMA

        void setRMA(RMAAccessBean ab)
        This method sets the RMA AccessBean representing the Return Merchandise Authorization record that authorizes the return of the merchandise.
        Parameters:
        ab - A RMAAccessBean that represents the RMA AccessBean for the Return Merchandise Authorization record.
Skip navigation links