com.ibm.commerce.payment.objects
Class PaymentMethodAccessBean

java.lang.Object
  com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
      com.ibm.commerce.payment.objects.PaymentMethodAccessBean
All Implemented Interfaces:
PaymentMethodAccessBeanData

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

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 &l This access bean corresponds to the database table 'PAYMTHD'.

See Also:
Serialized Form

Constructor Summary
PaymentMethodAccessBean()
Zero argument constructor used to initialize the access bean.
PaymentMethodAccessBean(javax.ejb.EJBObject o)
constructor
Method Summary
void commitCopyHelper()
Update(flush) data to the EJBObject (persistent storage).
protected java.lang.String defaultJNDIName()
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 paymentMethodId)
Retrieves the PaymentMethodAccessBean representing the payment method with the specified ID that the Store supports.
PaymentMethodDescriptionAccessBean getDescription(java.lang.Integer arg1, java.lang.Integer arg2)
Return a PaymentMethodDescriptionAccessBean object associated this payment method for the specified arg1.
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 arg1)
Returns the profile name if this payment method is supported by the specified Store, otherwise returns null.
protected void instantiateEJB()
protected boolean instantiateEJBByPrimaryKey()
void refreshCopyHelper()
Load data from the EJBObject.
void setInitKey_paymentMethodId(java.lang.String newValue)
Set the primary key for this object
void setProfileName(java.lang.String newValue)
This method accesses a non-CMP field
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaymentMethodAccessBean

public PaymentMethodAccessBean()
Zero argument constructor used to initialize the access bean. This constructor corresponds to the following home interface method: public abstract com.ibm.commerce.payment.objects.PaymentMethod com.ibm.commerce.payment.objimpl.PaymentMethodHomeBase.findByPrimaryKey(com.ibm.commerce.payment.objects.PaymentMethodKey) throws java.rmi.RemoteException,javax.ejb.FinderException The home interface method properties need to be set by calling the following setter methods before calling any business methods: setInitKey_paymentMethodId( java.lang.Integer )

PaymentMethodAccessBean

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

findByStoreAndPaymentMethod

public PaymentMethodAccessBean findByStoreAndPaymentMethod(java.lang.Integer storeId,
                                                           java.lang.Integer paymentMethodId)
                                                    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.
paymentMethodId - 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 paymentMethodId.
javax.naming.NamingException

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

setInitKey_paymentMethodId

public void setInitKey_paymentMethodId(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

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:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

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
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

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
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setProfileName

public void setProfileName(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setProfileName in interface PaymentMethodAccessBeanData

getDescription

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

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

Parameters:
arg1 - The language ID.
arg2 - 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

getSupportedProfileName

public java.lang.String getSupportedProfileName(java.lang.Integer arg1)
                                         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:
arg1 - 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

Feedback