com.ibm.commerce.user.objects
Class AddressBookAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractAccessBean
        |
        +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
              |
              +--com.ibm.commerce.user.objects.AddressBookAccessBean
All Implemented Interfaces:
AddressBookAccessBeanData, java.io.Serializable

public class AddressBookAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements AddressBookAccessBeanData

This bean provides access to the ADDRBOOK table.

The following is a description of this table:

This table contains information about an address book. An address book is a container for addresses owned by a member. A member can only have one address book.

See Also:
Serialized Form

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
AddressBookAccessBean()
          Default constructor.
AddressBookAccessBean(com.ibm.commerce.user.objimpl.AddressBookInputData aAddressBookInputData)
          Maps to a corresponding ejbCreate method in the home interface of the EJB
AddressBookAccessBean(javax.ejb.EJBObject Object)
          Creates an access bean for the specified EJB
AddressBookAccessBean(java.lang.Long aMemberId)
          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).
 AddressBookAccessBean findByMemberId(java.lang.Long aMemberId)
          Find by member id.
 java.lang.String getAddressBookId()
          This method provides access to the ADDRBOOK.ADDRBOOK_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getAddressBookIdInEJBType()
          This method provides access to the ADDRBOOK.ADDRBOOK_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getDescription()
          A description of the address book.
 java.lang.String getDisplayName()
          Display name is a short name used to refer to the address book.
 java.lang.String getMemberId()
          This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getMemberIdInEJBType()
          This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getType()
          The type of address book.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setDescription(java.lang.String aDescription)
          Set the description of the address book.
 void setDisplayName(java.lang.String aDisplayName)
          Set the short name used to refer to the address book.
 void setInitKey_AddressBookId(java.lang.String aInitKey_AddressBookId)
          Set the primary key for this object
 void setMemberId(java.lang.Long aMemberId)
          This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 void setMemberId(java.lang.String aMemberId)
          This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 void setType(java.lang.String aType)
          Set the type of address book, such as P (primary address book) or S (secondary address book).
 
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

AddressBookAccessBean

public AddressBookAccessBean()

Default constructor. Maps to findByPrimaryKey.


AddressBookAccessBean

public AddressBookAccessBean(com.ibm.commerce.user.objimpl.AddressBookInputData aAddressBookInputData)
                      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:
aAddressBookInputData - com.ibm.commerce.user.objimpl.AddressBookInputData
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

AddressBookAccessBean

public AddressBookAccessBean(javax.ejb.EJBObject Object)
                      throws java.rmi.RemoteException

Creates an access bean for the specified EJB

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

AddressBookAccessBean

public AddressBookAccessBean(java.lang.Long aMemberId)
                      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:
aMemberId - java.lang.Long
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

findByMemberId

public AddressBookAccessBean findByMemberId(java.lang.Long aMemberId)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException

Find by member id.

The SQL is "SELECT * FROM ADDRBOOK T1 WHERE(T1.MEMBER_ID = ?)"

Parameters:
aMemberId - java.lang.Long
Returns:
com.ibm.commerce.user.objects.AddressBookAccessBean
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

getAddressBookId

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

This method provides access to the ADDRBOOK.ADDRBOOK_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Unique address book reference number, internally generated. This is a primary key.

Specified by:
getAddressBookId in interface AddressBookAccessBeanData
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

getAddressBookIdInEJBType

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

This method provides access to the ADDRBOOK.ADDRBOOK_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Unique address book reference number, internally generated. This is a primary key.

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

getDescription

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

A description of the address book.

Specified by:
getDescription in interface AddressBookAccessBeanData
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

getDisplayName

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

Display name is a short name used to refer to the address book.

Specified by:
getDisplayName in interface AddressBookAccessBeanData
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

getMemberId

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

This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Foreign key to the MEMBER table. The member who owns this address book. Together with ADDRBOOK_ID, forms a unique key.

Specified by:
getMemberId in interface AddressBookAccessBeanData
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

getMemberIdInEJBType

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

This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Foreign key to the MEMBER table. The member who owns this address book. Together with ADDRBOOK_ID, forms a unique key.

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

getType

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

The type of address book. Valid values are P (primary address book) or S (secondary address book).

Specified by:
getType in interface AddressBookAccessBeanData
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

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

setDescription

public void setDescription(java.lang.String aDescription)

Set the description of the address book.

Specified by:
setDescription in interface AddressBookAccessBeanData
Parameters:
aDescription - java.lang.String
Returns:
void

setDisplayName

public void setDisplayName(java.lang.String aDisplayName)

Set the short name used to refer to the address book.

Specified by:
setDisplayName in interface AddressBookAccessBeanData
Parameters:
aDisplayName - java.lang.String
Returns:
void

setInitKey_AddressBookId

public void setInitKey_AddressBookId(java.lang.String aInitKey_AddressBookId)

Set the primary key for this object

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

setMemberId

public void setMemberId(java.lang.Long aMemberId)

This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Foreign key to the MEMBER table. The member who owns this address book. Together with ADDRBOOK_ID, forms a unique key.

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

setMemberId

public void setMemberId(java.lang.String aMemberId)

This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Foreign key to the MEMBER table. The member who owns this address book. Together with ADDRBOOK_ID, forms a unique key.

Specified by:
setMemberId in interface AddressBookAccessBeanData
Parameters:
aMemberId - java.lang.String
Returns:
void

setType

public void setType(java.lang.String aType)

Set the type of address book, such as P (primary address book) or S (secondary address book).

Specified by:
setType in interface AddressBookAccessBeanData
Parameters:
aType - java.lang.String
Returns:
void