com.ibm.commerce.ordermanagement.objects
Class RMAChargeAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
        |
        +--com.ibm.commerce.ordermanagement.objects.RMAChargeAccessBean
All Implemented Interfaces:
RMAChargeAccessBeanData

public class RMAChargeAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements RMAChargeAccessBeanData

This table stores charges or credits, applied to a return merchandise authorization (RMA), which are not for sellable products or services. This can be applicable to the entire RMA or to a specific RMA item, such as restocking fees or shipping credits.

See Also:
Serialized Form

Constructor Summary
RMAChargeAccessBean()
          constructor
RMAChargeAccessBean(javax.ejb.EJBObject o)
          constructor
RMAChargeAccessBean(java.lang.Long arg0, java.math.BigDecimal arg1, java.lang.String arg2, java.lang.Integer arg3)
          constructor
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
protected  java.lang.String defaultJNDIName()
           
 java.util.Enumeration findByRmaCharge(java.lang.Long arg0)           Retrieves all the RMA level charges for a RMA, meaning those which are not associated with a particular RMA item. The SQL query used to fetch the requested row from the RMACHARGE table is:
SELECT * FROM RMACHARGE T1 WHERE T1.RMA_ID = ? AND T1.RMAITEM_ID IS NULL
 java.util.Enumeration findByRmaItemId(java.lang.Long arg0)           Retrieves all the RMA charges associated with a RMA item. The SQL query used to fetch the requested row from the RMACHARGE table is:
SELECT * FROM RMACHARGE T1 WHERE T1.RMAITEM_ID = ?
 java.util.Enumeration findByRmaItemIdForUpdate(java.lang.Long arg0)           Retrieves all the RMA charges associated with a particular RMA item. The SQL query used to fetch the requested row from the RMACHARGE table is:
SELECT * FROM RMACHARGE T1 WHERE T1.RMAITEM_ID = ? FOR UPDATE
 java.lang.String getAmount()
          This method provides access to the RMACHARGE.AMOUNT column of DB2 type DECIMAL(20 5) NOT NULL.
 java.math.BigDecimal getAmountInEJBType()
          This method provides access to the RMACHARGE.AMOUNT column of DB2 type DECIMAL(20 5) NOT NULL.
 java.lang.String getChargeTypeId()
          This method provides access to the RMACHARGE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getChargeTypeIdInEJBType()
          This method provides access to the RMACHARGE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getCurrency()
          This method provides access to the RMACHARGE.CURRENCY column of DB2 type CHAR(3) NOT NULL.
 java.lang.String getRmaChargeId()
          This method provides access to the RMACHARGE.RMACHARGE_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getRmaChargeIdInEJBType()
          This method provides access to the RMACHARGE.RMACHARGE_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getRmaId()
          This method provides access to the RMACHARGE.RMA_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getRmaIdInEJBType()
          This method provides access to the RMACHARGE.RMA_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getRmaItemId()
          This method provides access to the RMACHARGE.RMAITEM_ID column of DB2 type BIGINT.
 java.lang.Long getRmaItemIdInEJBType()
          This method provides access to the RMACHARGE.RMAITEM_ID column of DB2 type BIGINT.
protected  void instantiateEJB()
           
protected  boolean instantiateEJBByPrimaryKey()
           
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setAmount(java.math.BigDecimal newValue)
          This method provides access to the RMACHARGE.AMOUNT column of DB2 type DECIMAL(20 5) NOT NULL.
 void setAmount(java.lang.String newValue)
          This method provides access to the RMACHARGE.AMOUNT column of DB2 type DECIMAL(20 5) NOT NULL.
 void setChargeTypeId(java.lang.Integer newValue)
          This method provides access to the RMACHARGE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.
 void setChargeTypeId(java.lang.String newValue)
          This method provides access to the RMACHARGE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.
 void setCurrency(java.lang.String newValue)
          This method provides access to the RMACHARGE.CURRENCY column of DB2 type CHAR(3) NOT NULL.
 void setInitKey_rmaChargeId(java.lang.String newValue)
          Set the primary key for this object
 void setRmaChargeId(java.lang.Long newValue)
          This method provides access to the RMACHARGE.RMACHARGE_ID column of DB2 type BIGINT NOT NULL.
 void setRmaChargeId(java.lang.String newValue)
          This method provides access to the RMACHARGE.RMACHARGE_ID column of DB2 type BIGINT NOT NULL.
 void setRmaId(java.lang.Long newValue)
          This method provides access to the RMACHARGE.RMA_ID column of DB2 type BIGINT NOT NULL.
 void setRmaId(java.lang.String newValue)
          This method provides access to the RMACHARGE.RMA_ID column of DB2 type BIGINT NOT NULL.
 void setRmaItemId(java.lang.Long newValue)
          This method provides access to the RMACHARGE.RMAITEM_ID column of DB2 type BIGINT.
 void setRmaItemId(java.lang.String newValue)
          This method provides access to the RMACHARGE.RMAITEM_ID column of DB2 type BIGINT.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RMAChargeAccessBean

public RMAChargeAccessBean()
constructor

RMAChargeAccessBean

public RMAChargeAccessBean(javax.ejb.EJBObject o)
                    throws java.rmi.RemoteException
constructor
Parameters:
o - javax.ejb.EJBObject
Throws:
java.rmi.RemoteException

RMAChargeAccessBean

public RMAChargeAccessBean(java.lang.Long arg0,
                           java.math.BigDecimal arg1,
                           java.lang.String arg2,
                           java.lang.Integer arg3)
                    throws javax.naming.NamingException,
                           javax.ejb.CreateException,
                           javax.ejb.FinderException,
                           java.rmi.RemoteException
constructor
Parameters:
arg0 - java.lang.Long
arg1 - java.math.BigDecimal
arg2 - java.lang.String
arg3 - java.lang.Integer
Throws:
javax.naming.NamingException
javax.ejb.CreateException
javax.ejb.FinderException
java.rmi.RemoteException
Method Detail

findByRmaCharge

public java.util.Enumeration findByRmaCharge(java.lang.Long arg0)
                                      throws java.rmi.RemoteException,
                                             javax.ejb.FinderException,
                                             javax.naming.NamingException

Retrieves all the RMA level charges for a RMA, meaning those which are not associated with a particular RMA item.
The SQL query used to fetch the requested row from the RMACHARGE table is: SELECT * FROM RMACHARGE T1 WHERE T1.RMA_ID = ? AND T1.RMAITEM_ID IS NULL

Returns:
java.util.Enumeration
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException

findByRmaItemId

public java.util.Enumeration findByRmaItemId(java.lang.Long arg0)
                                      throws java.rmi.RemoteException,
                                             javax.ejb.FinderException,
                                             javax.naming.NamingException

Retrieves all the RMA charges associated with a RMA item.
The SQL query used to fetch the requested row from the RMACHARGE table is: SELECT * FROM RMACHARGE T1 WHERE T1.RMAITEM_ID = ?

Returns:
An Enumeration of all the RMAChargeAccessBeans representing rows that match the search criteria.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException

findByRmaItemIdForUpdate

public java.util.Enumeration findByRmaItemIdForUpdate(java.lang.Long arg0)
                                               throws java.rmi.RemoteException,
                                                      javax.ejb.FinderException,
                                                      javax.naming.NamingException

Retrieves all the RMA charges associated with a particular RMA item.
The SQL query used to fetch the requested row from the RMACHARGE table is: SELECT * FROM RMACHARGE T1 WHERE T1.RMAITEM_ID = ? FOR UPDATE

Returns:
An Enumeration of all the RMAChargeAccessBeans representing rows that match the search criteria.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException

setInitKey_rmaChargeId

public void setInitKey_rmaChargeId(java.lang.String newValue)

Set the primary key for this object

Parameters:
newValue - java.lang.String
Returns:
void

defaultJNDIName

protected java.lang.String defaultJNDIName()
Returns:
String

instantiateEJB

protected void instantiateEJB()
                       throws java.rmi.RemoteException,
                              javax.ejb.FinderException,
                              javax.naming.NamingException
Returns:
void
Throws:
java.rmi.RemoteException
javax.ejb.FinderException
javax.naming.NamingException

instantiateEJBByPrimaryKey

protected boolean instantiateEJBByPrimaryKey()
                                      throws java.rmi.RemoteException,
                                             javax.ejb.CreateException,
                                             javax.naming.NamingException
Returns:
boolean
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.naming.NamingException

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).

Returns:
void
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

refreshCopyHelper

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

Load data from the EJBObject.

Returns:
void
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

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 RMACHARGE.AMOUNT column of DB2 type DECIMAL(20 5) NOT NULL.

The following is a description of this column:

Amount of the charge or credit.

Specified by:
getAmount in interface RMAChargeAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

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 RMACHARGE.AMOUNT column of DB2 type DECIMAL(20 5) NOT NULL.

The following is a description of this column:

Amount of the charge or credit.

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

setAmount

public void setAmount(java.lang.String newValue)

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

The following is a description of this column:

Amount of the charge or credit.

Specified by:
setAmount in interface RMAChargeAccessBeanData
Parameters:
newValue - String
Returns:
void

setAmount

public void setAmount(java.math.BigDecimal newValue)

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

The following is a description of this column:

Amount of the charge or credit.

Parameters:
newValue - java.math.BigDecimal
Returns:
void

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 RMACHARGE.CURRENCY column of DB2 type CHAR(3) NOT NULL.

The following is a description of this column:

Currency used for the charge or credit. This is a currency code as per ISO 4217 standards.

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

setCurrency

public void setCurrency(java.lang.String newValue)

This method provides access to the RMACHARGE.CURRENCY column of DB2 type CHAR(3) NOT NULL.

The following is a description of this column:

Currency used for the charge or credit. This is a currency code as per ISO 4217 standards.

Specified by:
setCurrency in interface RMAChargeAccessBeanData
Parameters:
newValue - java.lang.String
Returns:
void

getChargeTypeId

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

This method provides access to the RMACHARGE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The type of charge or credit. The CHARGETYPE_ID column is a foreign key to the CHARGETYPE table. A return policy uses the charge type of a restocking fee for returned items.

Specified by:
getChargeTypeId in interface RMAChargeAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getChargeTypeIdInEJBType

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

This method provides access to the RMACHARGE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The type of charge or credit. The CHARGETYPE_ID column is a foreign key to the CHARGETYPE table. A return policy uses the charge type of a restocking fee for returned items.

Returns:
java.lang.Integer
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setChargeTypeId

public void setChargeTypeId(java.lang.String newValue)

This method provides access to the RMACHARGE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The type of charge or credit. The CHARGETYPE_ID column is a foreign key to the CHARGETYPE table. A return policy uses the charge type of a restocking fee for returned items.

Specified by:
setChargeTypeId in interface RMAChargeAccessBeanData
Parameters:
newValue - String
Returns:
void

setChargeTypeId

public void setChargeTypeId(java.lang.Integer newValue)

This method provides access to the RMACHARGE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The type of charge or credit. The CHARGETYPE_ID column is a foreign key to the CHARGETYPE table. A return policy uses the charge type of a restocking fee for returned items.

Parameters:
newValue - java.lang.Integer
Returns:
void

getRmaItemId

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

This method provides access to the RMACHARGE.RMAITEM_ID column of DB2 type BIGINT.

The following is a description of this column:

The RMA item to which this charge applies. If this field is NULL, then the charge does not apply to a specific RMA item but against the whole RMA.

Specified by:
getRmaItemId in interface RMAChargeAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getRmaItemIdInEJBType

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

This method provides access to the RMACHARGE.RMAITEM_ID column of DB2 type BIGINT.

The following is a description of this column:

The RMA item to which this charge applies. If this field is NULL, then the charge does not apply to a specific RMA item but against the whole RMA.

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

setRmaItemId

public void setRmaItemId(java.lang.String newValue)

This method provides access to the RMACHARGE.RMAITEM_ID column of DB2 type BIGINT.

The following is a description of this column:

The RMA item to which this charge applies. If this field is NULL, then the charge does not apply to a specific RMA item but against the whole RMA.

Specified by:
setRmaItemId in interface RMAChargeAccessBeanData
Parameters:
newValue - String
Returns:
void

setRmaItemId

public void setRmaItemId(java.lang.Long newValue)

This method provides access to the RMACHARGE.RMAITEM_ID column of DB2 type BIGINT.

The following is a description of this column:

The RMA item to which this charge applies. If this field is NULL, then the charge does not apply to a specific RMA item but against the whole RMA.

Parameters:
newValue - java.lang.Long
Returns:
void

getRmaChargeId

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

This method provides access to the RMACHARGE.RMACHARGE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key.

Specified by:
getRmaChargeId in interface RMAChargeAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getRmaChargeIdInEJBType

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

This method provides access to the RMACHARGE.RMACHARGE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key.

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

setRmaChargeId

public void setRmaChargeId(java.lang.String newValue)

This method provides access to the RMACHARGE.RMACHARGE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key.

Specified by:
setRmaChargeId in interface RMAChargeAccessBeanData
Parameters:
newValue - String
Returns:
void

setRmaChargeId

public void setRmaChargeId(java.lang.Long newValue)

This method provides access to the RMACHARGE.RMACHARGE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key.

Parameters:
newValue - java.lang.Long
Returns:
void

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 RMACHARGE.RMA_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The RMA to which this charge or credit applies.

Specified by:
getRmaId in interface RMAChargeAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

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 RMACHARGE.RMA_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The RMA to which this charge or credit applies.

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

setRmaId

public void setRmaId(java.lang.String newValue)

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

The following is a description of this column:

The RMA to which this charge or credit applies.

Specified by:
setRmaId in interface RMAChargeAccessBeanData
Parameters:
newValue - String
Returns:
void

setRmaId

public void setRmaId(java.lang.Long newValue)

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

The following is a description of this column:

The RMA to which this charge or credit applies.

Parameters:
newValue - java.lang.Long
Returns:
void