com.ibm.commerce.payment.objects
Class TradingRefundAmountAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractAccessBean
        |
        +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
              |
              +--com.ibm.commerce.payment.objects.TradingRefundAmountAccessBean
All Implemented Interfaces:
java.io.Serializable, TradingRefundAmountAccessBeanData

public class TradingRefundAmountAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements TradingRefundAmountAccessBeanData

This bean provides access to the TRDREFAMT table.

The following is a description of this table:

This table is used to keep track of Refund Amounts by Trading Agreements, by Orders and by RMA Id. Entries are created only for Trading Agreement with Right-to-Buy by Amount or Obligation-to-Buy by Amount Terms and Conditions.

See Also:
Serialized Form

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
TradingRefundAmountAccessBean()
          Default constructor.
TradingRefundAmountAccessBean(javax.ejb.EJBObject object)
          Creates an access bean for the specified EJB
TradingRefundAmountAccessBean(java.lang.Long tradingID, java.lang.Long aRMAId, java.lang.Long orderId, java.math.BigDecimal refundAmount)
          Maps to a corresponding ejbCreate method in the home interface of the EJB
TradingRefundAmountAccessBean(java.lang.Long tradingID, java.lang.Long aRMAId, java.lang.Long orderId, java.math.BigDecimal refundAmount, java.lang.String currency)
          Maps to a corresponding ejbCreate method in the home interface of the EJB
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
 java.lang.String getAmount()
          This method provides access to the TRDREFAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.
 java.math.BigDecimal getAmountInEJBType()
          This method provides access to the TRDREFAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.
 java.lang.String getCurrency()
          This method provides access to the TRDREFAMT.SETCCURR column of DB2 type CHAR(3) NULL.
 java.lang.String getOrderId()
          This method provides access to the TRDREFAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getOrderIdInEJBType()
          This method provides access to the TRDREFAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getRmaId()
          This method provides access to the TRDREFAMT.RMA_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getRmaIdInEJBType()
          This method provides access to the TRDREFAMT.RMA_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getTradingId()
          This method provides access to the TRDREFAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getTradingIdInEJBType()
          This method provides access to the TRDREFAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setAmount(java.math.BigDecimal aAmount)
          This method provides access to the TRDREFAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.
 void setAmount(java.lang.String aAmount)
          This method provides access to the TRDREFAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.
 void setCurrency(java.lang.String aCurrency)
          This method provides access to the TRDREFAMT.SETCCURR column of DB2 type CHAR(3) NULL.
 void setInitKey_orderId(java.lang.String aInitKey_orderId)
          Set the primary key for this object
 void setInitKey_rmaId(java.lang.String aInitKey_rmaId)
          Set the primary key for this object
 void setInitKey_tradingId(java.lang.String aInitKey_tradingId)
          Set the primary key for this object
 void setOrderId(java.lang.Long aOrderId)
          This method provides access to the TRDREFAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 void setOrderId(java.lang.String aOrderId)
          This method provides access to the TRDREFAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 void setRmaId(java.lang.Long aRmaId)
          This method provides access to the TRDREFAMT.RMA_ID column of DB2 type BIGINT NOT NULL.
 void setRmaId(java.lang.String aRmaId)
          This method provides access to the TRDREFAMT.RMA_ID column of DB2 type BIGINT NOT NULL.
 void setTradingId(java.lang.Long aTradingId)
          This method provides access to the TRDREFAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.
 void setTradingId(java.lang.String aTradingId)
          This method provides access to the TRDREFAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.
 
Methods inherited from class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
__getCache, __getCache, __getKey, __setCache, __setCache, __setKey, commitCopyHelper, createAccessBeans, createAccessBeans, instantiateEJBByPrimaryKey, refreshCopyHelper, setEJBRef
 
Methods inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
defaultJNDIName, defaultNameServiceType, defaultNameServiceURL, getEJBRef, getGlobalHome, getHome, getInit_GlobalNameServiceTypeName, getInit_GlobalNameServiceURLName, getInit_JNDIName, getInit_NameServiceTypeName, getInit_NameServiceURLName, getInitContext, getInitContext, instantiateEJB, resetEJBRef, resetHomeCache, setInit_GlobalNameServiceTypeName, setInit_GlobalNameServiceURLName, setInit_JNDIName, setInit_NameServiceTypeName, setInit_NameServiceURLName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TradingRefundAmountAccessBean

public TradingRefundAmountAccessBean()

Default constructor. Maps to findByPrimaryKey.


TradingRefundAmountAccessBean

public TradingRefundAmountAccessBean(javax.ejb.EJBObject object)
                              throws java.rmi.RemoteException

Creates an access bean for the specified EJB

Parameters:
object - The EJB Object used for the access bean construction.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception

TradingRefundAmountAccessBean

public TradingRefundAmountAccessBean(java.lang.Long tradingID,
                                     java.lang.Long aRMAId,
                                     java.lang.Long orderId,
                                     java.math.BigDecimal refundAmount)
                              throws javax.ejb.CreateException,
                                     java.rmi.RemoteException,
                                     javax.naming.NamingException

Maps to a corresponding ejbCreate method in the home interface of the EJB

Parameters:
tradingID - The internal ID of the Trading Agreement.
aRMAId - The internal ID of the Return Merchandise Authorization.
orderId - The ID of the Order.
refundAmount - The refund amount.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.naming.NamingException - The javax.naming.NamingException exception

TradingRefundAmountAccessBean

public TradingRefundAmountAccessBean(java.lang.Long tradingID,
                                     java.lang.Long aRMAId,
                                     java.lang.Long orderId,
                                     java.math.BigDecimal refundAmount,
                                     java.lang.String currency)
                              throws javax.ejb.CreateException,
                                     java.rmi.RemoteException,
                                     javax.naming.NamingException

Maps to a corresponding ejbCreate method in the home interface of the EJB

Parameters:
tradingID - The internal ID of the Trading Agreement.
aRMAId - The internal ID of the Return Merchandise Authorization.
orderId - The ID of the Order.
refundAmount - The refund amount.
currency - The currency of the amount.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.naming.NamingException - The javax.naming.NamingException exception
Method Detail

commitCopyHelper

public void commitCopyHelper()
                      throws java.rmi.RemoteException,
                             javax.ejb.CreateException,
                             javax.ejb.FinderException,
                             javax.naming.NamingException

Update(flush) data to the EJBObject (persistent storage).

Overrides:
commitCopyHelper in class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getAmount

public java.lang.String getAmount()
                           throws java.rmi.RemoteException,
                                  javax.ejb.CreateException,
                                  javax.ejb.FinderException,
                                  javax.naming.NamingException

This method provides access to the TRDREFAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.

The following is a description of this column:

Total Refund Amount for this Trading Agreement for this RMA and Order. The amount is in the same currency of the Right-to-Buy Amount and Obligation-to-Buy Amount.

Specified by:
getAmount in interface TradingRefundAmountAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getAmountInEJBType

public java.math.BigDecimal getAmountInEJBType()
                                        throws java.rmi.RemoteException,
                                               javax.ejb.CreateException,
                                               javax.ejb.FinderException,
                                               javax.naming.NamingException

This method provides access to the TRDREFAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.

The following is a description of this column:

Total Refund Amount for this Trading Agreement for this RMA and Order. The amount is in the same currency of the Right-to-Buy Amount and Obligation-to-Buy Amount.

Returns:
java.math.BigDecimal
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getCurrency

public java.lang.String getCurrency()
                             throws java.rmi.RemoteException,
                                    javax.ejb.CreateException,
                                    javax.ejb.FinderException,
                                    javax.naming.NamingException

This method provides access to the TRDREFAMT.SETCCURR column of DB2 type CHAR(3) NULL.

The following is a description of this column:

Currency of the Amount field. This is a currency code as per ISO 4217 standards.

Specified by:
getCurrency in interface TradingRefundAmountAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getOrderId

public java.lang.String getOrderId()
                            throws java.rmi.RemoteException,
                                   javax.ejb.CreateException,
                                   javax.ejb.FinderException,
                                   javax.naming.NamingException

This method provides access to the TRDREFAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Order ID. Foreign key to the ORDERS table.

Specified by:
getOrderId in interface TradingRefundAmountAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getOrderIdInEJBType

public java.lang.Long getOrderIdInEJBType()
                                   throws java.rmi.RemoteException,
                                          javax.ejb.CreateException,
                                          javax.ejb.FinderException,
                                          javax.naming.NamingException

This method provides access to the TRDREFAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Order ID. Foreign key to the ORDERS table.

Returns:
java.lang.Long
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getRmaId

public java.lang.String getRmaId()
                          throws java.rmi.RemoteException,
                                 javax.ejb.CreateException,
                                 javax.ejb.FinderException,
                                 javax.naming.NamingException

This method provides access to the TRDREFAMT.RMA_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Return Merchandise Authorization (RMA).

Specified by:
getRmaId in interface TradingRefundAmountAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getRmaIdInEJBType

public java.lang.Long getRmaIdInEJBType()
                                 throws java.rmi.RemoteException,
                                        javax.ejb.CreateException,
                                        javax.ejb.FinderException,
                                        javax.naming.NamingException

This method provides access to the TRDREFAMT.RMA_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Return Merchandise Authorization (RMA).

Returns:
java.lang.Long
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getTradingId

public java.lang.String getTradingId()
                              throws java.rmi.RemoteException,
                                     javax.ejb.CreateException,
                                     javax.ejb.FinderException,
                                     javax.naming.NamingException

This method provides access to the TRDREFAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Trading Agreement. Foreign key to the TRADING table.

Specified by:
getTradingId in interface TradingRefundAmountAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getTradingIdInEJBType

public java.lang.Long getTradingIdInEJBType()
                                     throws java.rmi.RemoteException,
                                            javax.ejb.CreateException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException

This method provides access to the TRDREFAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Trading Agreement. Foreign key to the TRADING table.

Returns:
java.lang.Long
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

refreshCopyHelper

public void refreshCopyHelper()
                       throws java.rmi.RemoteException,
                              javax.ejb.CreateException,
                              javax.ejb.FinderException,
                              javax.naming.NamingException

Load data from the EJBObject.

Overrides:
refreshCopyHelper in class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

setAmount

public void setAmount(java.math.BigDecimal aAmount)

This method provides access to the TRDREFAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.

The following is a description of this column:

Total Refund Amount for this Trading Agreement for this RMA and Order. The amount is in the same currency of the Right-to-Buy Amount and Obligation-to-Buy Amount.

Parameters:
aAmount - java.math.BigDecimal

setAmount

public void setAmount(java.lang.String aAmount)

This method provides access to the TRDREFAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.

The following is a description of this column:

Total Refund Amount for this Trading Agreement for this RMA and Order. The amount is in the same currency of the Right-to-Buy Amount and Obligation-to-Buy Amount.

Specified by:
setAmount in interface TradingRefundAmountAccessBeanData
Parameters:
aAmount - java.lang.String

setCurrency

public void setCurrency(java.lang.String aCurrency)

This method provides access to the TRDREFAMT.SETCCURR column of DB2 type CHAR(3) NULL.

The following is a description of this column:

Currency of the Amount field. This is a currency code as per ISO 4217 standards.

Specified by:
setCurrency in interface TradingRefundAmountAccessBeanData
Parameters:
aCurrency - java.lang.String

setInitKey_orderId

public void setInitKey_orderId(java.lang.String aInitKey_orderId)

Set the primary key for this object

Parameters:
aInitKey_orderId - java.lang.String

setInitKey_rmaId

public void setInitKey_rmaId(java.lang.String aInitKey_rmaId)

Set the primary key for this object

Parameters:
aInitKey_rmaId - java.lang.String

setInitKey_tradingId

public void setInitKey_tradingId(java.lang.String aInitKey_tradingId)

Set the primary key for this object

Parameters:
aInitKey_tradingId - java.lang.String

setOrderId

public void setOrderId(java.lang.Long aOrderId)

This method provides access to the TRDREFAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Order ID. Foreign key to the ORDERS table.

Parameters:
aOrderId - java.lang.Long

setOrderId

public void setOrderId(java.lang.String aOrderId)

This method provides access to the TRDREFAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Order ID. Foreign key to the ORDERS table.

Specified by:
setOrderId in interface TradingRefundAmountAccessBeanData
Parameters:
aOrderId - java.lang.String

setRmaId

public void setRmaId(java.lang.Long aRmaId)

This method provides access to the TRDREFAMT.RMA_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Return Merchandise Authorization (RMA).

Parameters:
aRmaId - java.lang.Long

setRmaId

public void setRmaId(java.lang.String aRmaId)

This method provides access to the TRDREFAMT.RMA_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Return Merchandise Authorization (RMA).

Specified by:
setRmaId in interface TradingRefundAmountAccessBeanData
Parameters:
aRmaId - java.lang.String

setTradingId

public void setTradingId(java.lang.Long aTradingId)

This method provides access to the TRDREFAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Trading Agreement. Foreign key to the TRADING table.

Parameters:
aTradingId - java.lang.Long

setTradingId

public void setTradingId(java.lang.String aTradingId)

This method provides access to the TRDREFAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Trading Agreement. Foreign key to the TRADING table.

Specified by:
setTradingId in interface TradingRefundAmountAccessBeanData
Parameters:
aTradingId - java.lang.String