com.ibm.commerce.ordermanagement.objects
Class ChargeTypeAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractAccessBean
        |
        +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
              |
              +--com.ibm.commerce.ordermanagement.objects.ChargeTypeAccessBean
All Implemented Interfaces:
ChargeTypeAccessBeanData, java.io.Serializable

public class ChargeTypeAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements ChargeTypeAccessBeanData

This bean provides access to the CHARGETYPE table.

The following is a description of this table:

Charge or credit applied against a transaction which is not for product. Examples include expedite fees, customization fees, and restocking fees.

See Also:
Serialized Form

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
ChargeTypeAccessBean()
          Default constructor.
ChargeTypeAccessBean(javax.ejb.EJBObject ejbObject)
          Maps to a corresponding ejbCreate method in the home interface of the EJB
ChargeTypeAccessBean(java.lang.String code, java.lang.String displayAggregated, java.lang.Integer storeEntID)
          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.util.Enumeration findByCodeAndStoreIdOrStoreGroupIdOrderByStoreent(java.lang.String code, java.lang.Integer storeID, java.lang.Integer storeGroupID)
          Retrieves all the charge types defined for a store and its corresponding store group, and returns the list sorted by store entity.
The SQL query used to fetch the requested row from the CHARGETYPE table is:
SELECT * FROM CHARGETYPE T1 where T1.Code = ? and (T1.Storeent_id = ? or T1.Storeent_id=?) and T1.MarkForDelete=0 order by storeent_id desc
 java.lang.String getChargeTypeId()
          This method provides access to the CHARGETYPE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getChargeTypeIdInEJBType()
          This method provides access to the CHARGETYPE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getCode()
          This method provides access to the CHARGETYPE.CODE column of DB2 type CHAR(10) NOT NULL.
 java.lang.String getDisplayAggregated()
          This method provides access to the CHARGETYPE.DISPLAYAGGREGATED column of DB2 type CHAR(1) NOT NULL.
 java.lang.String getMarkForDeleted()
          This method provides access to the CHARGETYPE.MARKFORDELETE column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getMarkForDeletedInEJBType()
          This method provides access to the CHARGETYPE.MARKFORDELETE column of DB2 type INTEGER NOT NULL.
 java.lang.String getStoreentId()
          This method provides access to the CHARGETYPE.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getStoreentIdInEJBType()
          This method provides access to the CHARGETYPE.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setChargeTypeId(java.lang.Integer aChargeTypeId)
          This method provides access to the CHARGETYPE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.
 void setChargeTypeId(java.lang.String aChargeTypeId)
          This method provides access to the CHARGETYPE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.
 void setCode(java.lang.String aCode)
          This method provides access to the CHARGETYPE.CODE column of DB2 type CHAR(10) NOT NULL.
 void setDisplayAggregated(java.lang.String aDisplayAggregated)
          This method provides access to the CHARGETYPE.DISPLAYAGGREGATED column of DB2 type CHAR(1) NOT NULL.
 void setInitKey_chargeTypeId(java.lang.String aInitKey_chargeTypeId)
          Set the primary key for this object
 void setMarkForDeleted(java.lang.Integer aMarkForDeleted)
          This method provides access to the CHARGETYPE.MARKFORDELETE column of DB2 type INTEGER NOT NULL.
 void setMarkForDeleted(java.lang.String aMarkForDeleted)
          This method provides access to the CHARGETYPE.MARKFORDELETE column of DB2 type INTEGER NOT NULL.
 void setStoreentId(java.lang.Integer aStoreentId)
          This method provides access to the CHARGETYPE.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setStoreentId(java.lang.String aStoreentId)
          This method provides access to the CHARGETYPE.STOREENT_ID column of DB2 type INTEGER 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

ChargeTypeAccessBean

public ChargeTypeAccessBean()

Default constructor. Maps to findByPrimaryKey.


ChargeTypeAccessBean

public ChargeTypeAccessBean(javax.ejb.EJBObject ejbObject)
                     throws java.rmi.RemoteException

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

Parameters:
ejbObject - javax.ejb.EJBObject
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception

ChargeTypeAccessBean

public ChargeTypeAccessBean(java.lang.String code,
                            java.lang.String displayAggregated,
                            java.lang.Integer storeEntID)
                     throws javax.naming.NamingException,
                            javax.ejb.CreateException,
                            java.rmi.RemoteException,
                            javax.ejb.FinderException

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

Parameters:
code - java.lang.String Code
displayAggregated - java.lang.String Display Aggregated
storeEntID - java.lang.Integer StoreEnt_id
Throws:
javax.naming.NamingException - The javax.naming.NamingException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException 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
Returns:
void
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

findByCodeAndStoreIdOrStoreGroupIdOrderByStoreent

public java.util.Enumeration findByCodeAndStoreIdOrStoreGroupIdOrderByStoreent(java.lang.String code,
                                                                               java.lang.Integer storeID,
                                                                               java.lang.Integer storeGroupID)
                                                                        throws java.rmi.RemoteException,
                                                                               javax.ejb.FinderException,
                                                                               javax.naming.NamingException

Retrieves all the charge types defined for a store and its corresponding store group, and returns the list sorted by store entity.
The SQL query used to fetch the requested row from the CHARGETYPE table is:
SELECT * FROM CHARGETYPE T1 where T1.Code = ? and (T1.Storeent_id = ? or T1.Storeent_id=?) and T1.MarkForDelete=0 order by storeent_id desc

Parameters:
code - java.lang.String Code
storeID - java.lang.Integer Store ID
storeGroupID - java.lang.Integer Store Group ID
Returns:
An Enumeration of all the ChargeTypeAccessBeans 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 - The javax.naming.NamingException exception

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 CHARGETYPE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Generated unique key.

Specified by:
getChargeTypeId in interface ChargeTypeAccessBeanData
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

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 CHARGETYPE.CHARGETYPE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Generated unique key.

Returns:
java.lang.Integer
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

getCode

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

This method provides access to the CHARGETYPE.CODE column of DB2 type CHAR(10) NOT NULL.

The following is a description of this column:

Code used for referencing this Charge Type. Used for identifying the same charge type defined at the store and store group level.

Specified by:
getCode in interface ChargeTypeAccessBeanData
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

getDisplayAggregated

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

This method provides access to the CHARGETYPE.DISPLAYAGGREGATED column of DB2 type CHAR(1) NOT NULL.

The following is a description of this column:

A suggestion to the GUI to aggregate the charge or credit into the appropriate transaction or transaction item for display purposes. Charges or credits are stored individually to facilitate tax calculations.

Specified by:
getDisplayAggregated in interface ChargeTypeAccessBeanData
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

getMarkForDeleted

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

This method provides access to the CHARGETYPE.MARKFORDELETE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Indicates if this Charge Type has been marked for deletion:
0 = No.
1 = Yes.

Specified by:
getMarkForDeleted in interface ChargeTypeAccessBeanData
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

getMarkForDeletedInEJBType

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

This method provides access to the CHARGETYPE.MARKFORDELETE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Indicates if this Charge Type has been marked for deletion:
0 = No.
1 = Yes.

Returns:
java.lang.Integer
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

getStoreentId

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

This method provides access to the CHARGETYPE.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The Store Entity that uses this Charge Type.

Specified by:
getStoreentId in interface ChargeTypeAccessBeanData
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

getStoreentIdInEJBType

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

This method provides access to the CHARGETYPE.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The Store Entity that uses this Charge Type.

Returns:
java.lang.Integer
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
Returns:
void
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

setChargeTypeId

public void setChargeTypeId(java.lang.Integer aChargeTypeId)

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

The following is a description of this column:

Generated unique key.

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

setChargeTypeId

public void setChargeTypeId(java.lang.String aChargeTypeId)

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

The following is a description of this column:

Generated unique key.

Specified by:
setChargeTypeId in interface ChargeTypeAccessBeanData
Parameters:
aChargeTypeId - java.lang.String
Returns:
void

setCode

public void setCode(java.lang.String aCode)

This method provides access to the CHARGETYPE.CODE column of DB2 type CHAR(10) NOT NULL.

The following is a description of this column:

Code used for referencing this Charge Type. Used for identifying the same charge type defined at the store and store group level.

Specified by:
setCode in interface ChargeTypeAccessBeanData
Parameters:
aCode - java.lang.String
Returns:
void

setDisplayAggregated

public void setDisplayAggregated(java.lang.String aDisplayAggregated)

This method provides access to the CHARGETYPE.DISPLAYAGGREGATED column of DB2 type CHAR(1) NOT NULL.

The following is a description of this column:

A suggestion to the GUI to aggregate the charge or credit into the appropriate transaction or transaction item for display purposes. Charges or credits are stored individually to facilitate tax calculations.

Specified by:
setDisplayAggregated in interface ChargeTypeAccessBeanData
Parameters:
aDisplayAggregated - java.lang.String
Returns:
void

setInitKey_chargeTypeId

public void setInitKey_chargeTypeId(java.lang.String aInitKey_chargeTypeId)

Set the primary key for this object

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

setMarkForDeleted

public void setMarkForDeleted(java.lang.Integer aMarkForDeleted)

This method provides access to the CHARGETYPE.MARKFORDELETE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Indicates if this Charge Type has been marked for deletion:
0 = No.
1 = Yes.

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

setMarkForDeleted

public void setMarkForDeleted(java.lang.String aMarkForDeleted)

This method provides access to the CHARGETYPE.MARKFORDELETE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Indicates if this Charge Type has been marked for deletion:
0 = No.
1 = Yes.

Specified by:
setMarkForDeleted in interface ChargeTypeAccessBeanData
Parameters:
aMarkForDeleted - java.lang.String
Returns:
void

setStoreentId

public void setStoreentId(java.lang.Integer aStoreentId)

This method provides access to the CHARGETYPE.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The Store Entity that uses this Charge Type.

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

setStoreentId

public void setStoreentId(java.lang.String aStoreentId)

This method provides access to the CHARGETYPE.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The Store Entity that uses this Charge Type.

Specified by:
setStoreentId in interface ChargeTypeAccessBeanData
Parameters:
aStoreentId - java.lang.String
Returns:
void