com.ibm.commerce.payment.objects
Class PaymentMethodAccessBean

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

public class PaymentMethodAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements PaymentMethodAccessBeanData

This bean provides access to the PAYMTHD table.

The following is a description of this table:

This table is a site-wide table that lists all the Cashier profiles used in the store group. Each profile has a unique integer ID and a name. This table is deprecated and is provided for backward compatibility only.

See Also:
Serialized Form

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
PaymentMethodAccessBean()
          Default constructor.
PaymentMethodAccessBean(javax.ejb.EJBObject object)
          Creates an access bean for the specified EJB
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
 java.util.Enumeration findByStore(java.lang.Integer storeId)
          Retrieves all the payment methods that the Store supports.
 PaymentMethodAccessBean findByStoreAndPaymentMethod(java.lang.Integer storeId, java.lang.Integer payMethodID)
          Retrieves the PaymentMethodAccessBean representing the payment method with the specified ID that the Store supports.
 PaymentMethodDescriptionAccessBean getDescription(java.lang.Integer languageId, java.lang.Integer storeId)
          Return a PaymentMethodDescriptionAccessBean object associated this payment method for the specified languageId.
 java.lang.String getPaymentMethodId()
          This method provides access to the PAYMTHD.PAYMTHD_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getPaymentMethodIdInEJBType()
          This method provides access to the PAYMTHD.PAYMTHD_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getProfileName()
          This method provides access to the PAYMTHD.PROFILENAME column of DB2 type VARCHAR(64) NOT NULL.
 java.lang.String getSupportedProfileName(java.lang.Integer storeId)
          Returns the profile name if this payment method is supported by the specified Store, otherwise returns null.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setInitKey_paymentMethodId(java.lang.String aInitKey_paymentMethodId)
          Set the primary key for this object
 void setProfileName(java.lang.String aProfileName)
          This method provides access to the PAYMTHD.PROFILENAME column of DB2 type VARCHAR(64) 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

PaymentMethodAccessBean

public PaymentMethodAccessBean()

Default constructor. Maps to findByPrimaryKey.


PaymentMethodAccessBean

public PaymentMethodAccessBean(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
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

findByStore

public java.util.Enumeration findByStore(java.lang.Integer storeId)
                                  throws java.rmi.RemoteException,
                                         javax.ejb.FinderException,
                                         javax.naming.NamingException

Retrieves all the payment methods that the Store supports.

The SQL query used to fetch all the required rows from the PAYMTHD table is:

SELECT * FROM PAYMTHD T1 WHERE T1.PAYMTHD_ID IN (SELECT PAYMTHDSUP.PAYMTHD_ID FROM PAYMTHDSUP WHERE PAYMTHDSUP.STOREENT_ID = ?)

Parameters:
storeId - The ID of the Store.
Returns:
An Enumeration of all the PaymentMethodAccessBeans 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

findByStoreAndPaymentMethod

public PaymentMethodAccessBean findByStoreAndPaymentMethod(java.lang.Integer storeId,
                                                           java.lang.Integer payMethodID)
                                                    throws java.rmi.RemoteException,
                                                           javax.ejb.FinderException,
                                                           javax.naming.NamingException

Retrieves the PaymentMethodAccessBean representing the payment method with the specified ID that the Store supports.

The SQL query used to fetch the requested row from the PAYMTHD table is:

SELECT * FROM PAYMTHD T1 WHERE T1.PAYMTHD_ID = (SELECT PAYMTHDSUP.PAYMTHD_ID FROM PAYMTHDSUP WHERE PAYMTHDSUP.STOREENT_ID = ? AND PAYMTHDSUP.PAYMTHD_ID = ?)

Parameters:
storeId - The ID of the Store.
payMethodId - The internal ID of the payment method.
Returns:
The PaymentMethodAccessBean representing the row that matches the search criteria.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - If the Store does not support the payment method with the specified payMethodID.
javax.naming.NamingException - The javax.naming.NamingException exception

getDescription

public PaymentMethodDescriptionAccessBean getDescription(java.lang.Integer languageId,
                                                         java.lang.Integer storeId)
                                                  throws javax.naming.NamingException,
                                                         javax.ejb.CreateException,
                                                         javax.ejb.FinderException,
                                                         java.rmi.RemoteException

Return a PaymentMethodDescriptionAccessBean object associated this payment method for the specified languageId. If there is no description for the specified language, the alternative languages for languageId and storeId will be used to get an appropriate description.

Parameters:
languageId - The language ID.
storeId - The ID of the Store.
Returns:
The PaymentMethodDescriptionAccessBean for this payment method.
Throws:
javax.naming.NamingException - The javax.naming.NamingException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception

getPaymentMethodId

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

This method provides access to the PAYMTHD.PAYMTHD_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The unique integer ID of the profile.

Specified by:
getPaymentMethodId in interface PaymentMethodAccessBeanData
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

getPaymentMethodIdInEJBType

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

This method provides access to the PAYMTHD.PAYMTHD_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The unique integer ID of the profile.

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

getProfileName

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

This method provides access to the PAYMTHD.PROFILENAME column of DB2 type VARCHAR(64) NOT NULL.

The following is a description of this column:

The name of the profile. It must be the same as the simple filename, without the suffix .profile, of the XML file that contains the cashier profile. (Note that the name is case-sensitive and must include the name of the Cassette as a substring.)

Specified by:
getProfileName in interface PaymentMethodAccessBeanData
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

getSupportedProfileName

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

Returns the profile name if this payment method is supported by the specified Store, otherwise returns null.

Parameters:
storeId - The ID of the Store.
Returns:
The name of the profile used by this payment method.
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

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

setInitKey_paymentMethodId

public void setInitKey_paymentMethodId(java.lang.String aInitKey_paymentMethodId)

Set the primary key for this object

Parameters:
aInitKey_paymentMethodId - java.lang.String

setProfileName

public void setProfileName(java.lang.String aProfileName)

This method provides access to the PAYMTHD.PROFILENAME column of DB2 type VARCHAR(64) NOT NULL.

The following is a description of this column:

The name of the profile. It must be the same as the simple filename, without the suffix .profile, of the XML file that contains the cashier profile. (Note that the name is case-sensitive and must include the name of the Cassette as a substring.)

Specified by:
setProfileName in interface PaymentMethodAccessBeanData
Parameters:
aProfileName - java.lang.String