com.ibm.commerce.user.objects
Class AddressBookAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
        |
        +--com.ibm.commerce.user.objects.AddressBookAccessBean
All Implemented Interfaces:
AddressBookAccessBeanData
Direct Known Subclasses:
AddressBookDataBean

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

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

Constructor Summary
AddressBookAccessBean()
          constructor
AddressBookAccessBean(javax.ejb.EJBObject o)
          constructor
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
protected  java.lang.String defaultJNDIName()
           
  AddressBookAccessBean findByMemberId(java.lang.Long arg0)
          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()
          This method provides access to the ADDRBOOK.DESCRIPTION column of DB2 type VARCHAR(254).
 java.lang.String getDisplayName()
          This method provides access to the ADDRBOOK.DISPLAYNAME column of DB2 type VARCHAR(254) NOT NULL.
 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()
          This method provides access to the ADDRBOOK.TYPE column of DB2 type CHAR(1).
protected  void instantiateEJB()
           
protected  boolean instantiateEJBByPrimaryKey()
           
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setDescription(java.lang.String newValue)
          This method provides access to the ADDRBOOK.DESCRIPTION column of DB2 type VARCHAR(254).
 void setDisplayName(java.lang.String newValue)
          This method provides access to the ADDRBOOK.DISPLAYNAME column of DB2 type VARCHAR(254) NOT NULL.
 void setInitKey_AddressBookId(java.lang.String newValue)
          Set the primary key for this object
 void setMemberId(java.lang.Long newValue)
          This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 void setMemberId(java.lang.String newValue)
          This method provides access to the ADDRBOOK.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 void setType(java.lang.String newValue)
          This method provides access to the ADDRBOOK.TYPE column of DB2 type CHAR(1).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AddressBookAccessBean

public AddressBookAccessBean()
constructor

AddressBookAccessBean

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

findByMemberId

public AddressBookAccessBean findByMemberId(java.lang.Long arg0)
                                     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 = ?)"

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

setInitKey_AddressBookId

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

getDescription

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

This method provides access to the ADDRBOOK.DESCRIPTION column of DB2 type VARCHAR(254).

The following is a description of this column:

A description of the address book.

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

setDescription

public void setDescription(java.lang.String newValue)

This method provides access to the ADDRBOOK.DESCRIPTION column of DB2 type VARCHAR(254).

The following is a description of this column:

A description of the address book.

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

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

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

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

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

setMemberId

public void setMemberId(java.lang.String newValue)

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:
newValue - String
Returns:
void

setMemberId

public void setMemberId(java.lang.Long newValue)

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

getType

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

This method provides access to the ADDRBOOK.TYPE column of DB2 type CHAR(1).

The following is a description of this column:

The type of address book. Valid values are P (primary address book) or S (secondary address book). Only one (primary) address book per member is supported.

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

setType

public void setType(java.lang.String newValue)

This method provides access to the ADDRBOOK.TYPE column of DB2 type CHAR(1).

The following is a description of this column:

The type of address book. Valid values are P (primary address book) or S (secondary address book). Only one (primary) address book per member is supported.

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

getDisplayName

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

This method provides access to the ADDRBOOK.DISPLAYNAME column of DB2 type VARCHAR(254) NOT NULL.

The following is a description of this column:

A short name used to refer to the address book. This name is useful when listing an address book on a single line. Currently, there is no user interface and commands to manage the address book, so a default value is generated for the display name.

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

setDisplayName

public void setDisplayName(java.lang.String newValue)

This method provides access to the ADDRBOOK.DISPLAYNAME column of DB2 type VARCHAR(254) NOT NULL.

The following is a description of this column:

A short name used to refer to the address book. This name is useful when listing an address book on a single line. Currently, there is no user interface and commands to manage the address book, so a default value is generated for the display name.

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