com.ibm.commerce.marketingcenter.objects
Class EMarketingSpotAccessBean

com.ibm.commerce.marketingcenter.objects.EMarketingSpotAccessBean

public class EMarketingSpotAccessBean

This bean provides access to the EMSPOT table.

The following is a description of this table:

This table holds the information related to an e-marketing spot.


Constructor Summary
EMarketingSpotAccessBean()
          Zero argument constructor used to initialize the access bean.
EMarketingSpotAccessBean(javax.ejb.EJBObject EMarketingSpotEJBObj)
          Maps to a corresponding ejbCreate method in the home interface of the EJB.
EMarketingSpotAccessBean(java.lang.Integer emSpotId, java.lang.Integer storeId, java.lang.String emSpotName)
          Maps to a corresponding ejbCreate method in the home interface of the EJB.
EMarketingSpotAccessBean(java.lang.Integer storeId, java.lang.String emSpotName)
          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).
protected  java.lang.String defaultJNDIName()
          Obtain the JNDI name for this EJB
 EMarketingSpotAccessBean findByStoreIdAndName(java.lang.Integer storeId, java.lang.String emSpotName)
          This finder returns the e-marketing spot in an access bean with the given store reference number and the e-marketing spot name.
 java.util.Enumeration findByStoreIdSortedByDescription(java.lang.Integer storeId)
          This finder returns all the e-marketing spots in an enumeration with the given store reference number, sorted by description.
 java.util.Enumeration findByStoreIdSortedByName(java.lang.Integer storeId)
          This finder returns all the e-marketing spots in an enumeration with the given store reference number, sorted by name.
 boolean fulfills(java.lang.Long arg0, java.lang.String arg1)
          IBM internal use only.
 java.lang.String getDescription()
          This method provides access to the EMSPOT.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 java.lang.String getEMarketingSpotId()
          This method provides access to the EMSPOT.EMSPOT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getEMarketingSpotIdInEJBType()
          This method provides access to the EMSPOT.EMSPOT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getName()
          This method provides access to the EMSPOT.NAME column of DB2 type VARCHAR(64) NOT NULL.
 java.lang.Long getOwner()
          IBM internal use only.
 java.lang.String getStoreId()
          This method provides access to the EMSPOT.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getStoreIdInEJBType()
          This method provides access to the EMSPOT.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getSupportedTypes()
          This method provides access to the EMSPOT.SUPPORTEDTYPES column of DB2 type VARCHAR(20) NULL.
protected  void instantiateEJB()
          IBM internal use only
protected  boolean instantiateEJBByPrimaryKey()
          IBM internal use only
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setDescription(java.lang.String description)
          This method provides access to the EMSPOT.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 void setEMarketingSpotId(java.lang.Integer eMarketingSpotId)
          This method provides access to the EMSPOT.EMSPOT_ID column of DB2 type INTEGER NOT NULL.
 void setEMarketingSpotId(java.lang.String eMarketingSpotId)
          This method provides access to the EMSPOT.EMSPOT_ID column of DB2 type INTEGER NOT NULL.
 void setInitKey__eMarketingSpotId(java.lang.String newEMarketingSpotId)
          Set the primary key for this object.
 void setName(java.lang.String name)
          This method provides access to the EMSPOT.NAME column of DB2 type VARCHAR(64) NOT NULL.
 void setStoreId(java.lang.Integer storeId)
          This method provides access to the EMSPOT.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setStoreId(java.lang.String storeId)
          This method provides access to the EMSPOT.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setSupportedTypes(java.lang.String supportedTypes)
          This method provides access to the EMSPOT.SUPPORTEDTYPES column of DB2 type VARCHAR(20) NULL.
 

Constructor Detail

EMarketingSpotAccessBean

public EMarketingSpotAccessBean()
Zero argument constructor used to initialize the access bean. This constructor corresponds to the following home interface method: public abstract com.ibm.commerce.marketingcenter.objects.EMarketingSpot com.ibm.commerce.marketingcenter.objimpl.EMarketingSpotHomeBase.findByPrimaryKey(com.ibm.commerce.marketingcenter.objects.EMarketingSpotKey) 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__eMarketingSpotId( java.lang.Integer )

EMarketingSpotAccessBean

public EMarketingSpotAccessBean(javax.ejb.EJBObject EMarketingSpotEJBObj)
                         throws java.rmi.RemoteException
Maps to a corresponding ejbCreate method in the home interface of the EJB.
Parameters:
EMarketingSpotEJBObj - - an EMarketingSpot EJBObject reference
Throws:
java.rmi.RemoteException - - Thrown when the ejbCreate method is failed to invoke.

EMarketingSpotAccessBean

public EMarketingSpotAccessBean(java.lang.Integer emSpotId,
                                java.lang.Integer storeId,
                                java.lang.String emSpotName)
                         throws javax.ejb.CreateException,
                                java.rmi.RemoteException,
                                javax.naming.NamingException
Maps to a corresponding ejbCreate method in the home interface of the EJB.
Parameters:
emSpotId - - the internal reference number of the e-marketing spot
storeId - - the internal reference number of the store
emSpotName - - the name of the e-marketing spot
Throws:
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
java.rmi.RemoteException - - Thrown when the ejbCreate method is failed to invoke.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

EMarketingSpotAccessBean

public EMarketingSpotAccessBean(java.lang.Integer storeId,
                                java.lang.String emSpotName)
                         throws javax.ejb.FinderException,
                                javax.naming.NamingException,
                                javax.ejb.CreateException,
                                java.rmi.RemoteException
Maps to a corresponding ejbCreate method in the home interface of the EJB.
Parameters:
storeId - - the internal reference number of the store
emSpotName - - the name of the e-marketing spot
Throws:
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
java.rmi.RemoteException - - Thrown when the ejbCreate method is failed to invoke.
javax.naming.NamingException - - Thrown when a naming exception is encountered.
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).
Throws:
java.rmi.RemoteException - - Thrown when the remote method is failed to invoke.
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

defaultJNDIName

protected java.lang.String defaultJNDIName()
Obtain the JNDI name for this EJB
Returns:
java.lang.String - the JNDI name for this EJB

findByStoreIdAndName

public EMarketingSpotAccessBean findByStoreIdAndName(java.lang.Integer storeId,
                                                     java.lang.String emSpotName)
                                              throws java.rmi.RemoteException,
                                                     javax.ejb.FinderException,
                                                     javax.naming.NamingException
This finder returns the e-marketing spot in an access bean with the given store reference number and the e-marketing spot name.

SQL:

SELECT * FROM EMSPOT T1 WHERE (T1.STOREENT_ID = storeId AND T1.NAME = emSpotName)

Parameters:
storeId - - the reference number of the store
emSpotName - - the name of the e-marketing spot
Returns:
com.ibm.commerce.marketingcenter.objects.EMarketingSpotAccessBean - the returned e-marketing spot
Throws:
java.rmi.RemoteException - - Thrown when the ejbCreate method is failed to invoke.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

findByStoreIdSortedByDescription

public java.util.Enumeration findByStoreIdSortedByDescription(java.lang.Integer storeId)
                                                       throws java.rmi.RemoteException,
                                                              javax.ejb.FinderException,
                                                              javax.naming.NamingException
This finder returns all the e-marketing spots in an enumeration with the given store reference number, sorted by description.

SQL:

SELECT * FROM EMSPOT T1 WHERE ( T1.STOREENT_ID = storeId ) ORDER BY T1.DESCRIPTION

Parameters:
storeId - - the internal reference number of the store
Returns:
java.util.Enumeration - all the returned e-marketing spots
Throws:
java.rmi.RemoteException - - Thrown when the ejbCreate method is failed to invoke.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

findByStoreIdSortedByName

public java.util.Enumeration findByStoreIdSortedByName(java.lang.Integer storeId)
                                                throws java.rmi.RemoteException,
                                                       javax.ejb.FinderException,
                                                       javax.naming.NamingException
This finder returns all the e-marketing spots in an enumeration with the given store reference number, sorted by name.

SQL:

SELECT * FROM EMSPOT T1 WHERE ( T1.STOREENT_ID = storeId ) ORDER BY T1.NAME

Parameters:
storeId - - the internal reference number of the store
Returns:
java.util.Enumeration - all the returned e-marketing spots
Throws:
java.rmi.RemoteException - - Thrown when the ejbCreate method is failed to invoke.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

fulfills

public boolean fulfills(java.lang.Long arg0,
                        java.lang.String arg1)
                 throws java.rmi.RemoteException,
                        java.lang.Exception,
                        javax.ejb.FinderException,
                        javax.naming.NamingException
IBM internal use only.
Parameters:
arg0 - - java.lang.Long
arg1 - - java.lang.String
Returns:
boolean
Throws:
java.rmi.RemoteException - - The java.rmi.RemoteException exception
java.lang.Exception - - The java.lang.Exception 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
This method provides access to the EMSPOT.DESCRIPTION column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The description of this e-marketing spot.

Returns:
java.lang.String
Throws:
java.rmi.RemoteException - - Thrown when the remote method is failed to invoke.
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

getEMarketingSpotId

public java.lang.String getEMarketingSpotId()
                                     throws java.rmi.RemoteException,
                                            javax.ejb.CreateException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException
This method provides access to the EMSPOT.EMSPOT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of this e-marketing spot.

Returns:
java.lang.String
Throws:
java.rmi.RemoteException - - Thrown when the remote method is failed to invoke.
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

getEMarketingSpotIdInEJBType

public java.lang.Integer getEMarketingSpotIdInEJBType()
                                               throws java.rmi.RemoteException,
                                                      javax.ejb.CreateException,
                                                      javax.ejb.FinderException,
                                                      javax.naming.NamingException
This method provides access to the EMSPOT.EMSPOT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of this e-marketing spot.

Returns:
java.lang.Integer
Throws:
java.rmi.RemoteException - - Thrown when the remote method is failed to invoke.
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException,
                                javax.ejb.CreateException,
                                javax.ejb.FinderException,
                                javax.naming.NamingException
This method provides access to the EMSPOT.NAME column of DB2 type VARCHAR(64) NOT NULL.

The following is a description of this column:

The name of this e-marketing spot.

Returns:
java.lang.String
Throws:
java.rmi.RemoteException - - Thrown when the remote method is failed to invoke.
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

getOwner

public java.lang.Long getOwner()
                        throws java.lang.Exception,
                               java.rmi.RemoteException,
                               javax.ejb.FinderException,
                               javax.naming.NamingException
IBM internal use only.
Returns:
java.lang.Long
Throws:
java.lang.Exception - - The java.lang.Exception exception
java.rmi.RemoteException - - The java.rmi.RemoteException exception
javax.ejb.FinderException - - The javax.ejb.FinderException exception
javax.naming.NamingException - - The javax.naming.NamingException exception

getStoreId

public java.lang.String getStoreId()
                            throws java.rmi.RemoteException,
                                   javax.ejb.CreateException,
                                   javax.ejb.FinderException,
                                   javax.naming.NamingException
This method provides access to the EMSPOT.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of the store in which this e-marketing spot belongs to. This field is a foreign key to the STOREENT table.

Returns:
java.lang.String
Throws:
java.rmi.RemoteException - - Thrown when the remote method is failed to invoke.
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

getStoreIdInEJBType

public java.lang.Integer getStoreIdInEJBType()
                                      throws java.rmi.RemoteException,
                                             javax.ejb.CreateException,
                                             javax.ejb.FinderException,
                                             javax.naming.NamingException
This method provides access to the EMSPOT.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of the store in which this e-marketing spot belongs to. This field is a foreign key to the STOREENT table.

Returns:
java.lang.Integer
Throws:
java.rmi.RemoteException - - Thrown when the remote method is failed to invoke.
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

getSupportedTypes

public java.lang.String getSupportedTypes()
                                   throws java.rmi.RemoteException,
                                          javax.ejb.CreateException,
                                          javax.ejb.FinderException,
                                          javax.naming.NamingException
This method provides access to the EMSPOT.SUPPORTEDTYPES column of DB2 type VARCHAR(20) NULL.

The following is a description of this column:

The supported types of this e-marketing spot.

Returns:
java.lang.String
Throws:
java.rmi.RemoteException - - Thrown when the remote method is failed to invoke.
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

instantiateEJB

protected void instantiateEJB()
                       throws java.rmi.RemoteException,
                              javax.ejb.FinderException,
                              javax.naming.NamingException
IBM internal use only

instantiateEJBByPrimaryKey

protected boolean instantiateEJBByPrimaryKey()
                                      throws java.rmi.RemoteException,
                                             javax.ejb.CreateException,
                                             javax.naming.NamingException
IBM internal use only

refreshCopyHelper

public void refreshCopyHelper()
                       throws java.rmi.RemoteException,
                              javax.ejb.CreateException,
                              javax.ejb.FinderException,
                              javax.naming.NamingException
Load data from the EJBObject.
Throws:
java.rmi.RemoteException - - Thrown when the remote method is failed to invoke.
javax.ejb.CreateException - - Thrown when the creation of the EJB object failed.
javax.ejb.FinderException - - Thrown when the finding of the requested EJB object failed.
javax.naming.NamingException - - Thrown when a naming exception is encountered.

setDescription

public void setDescription(java.lang.String description)
This method provides access to the EMSPOT.DESCRIPTION column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The description of this e-marketing spot.

Parameters:
java.lang.String -  

setEMarketingSpotId

public void setEMarketingSpotId(java.lang.Integer eMarketingSpotId)
This method provides access to the EMSPOT.EMSPOT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of this e-marketing spot.

Parameters:
java.lang.Integer -  

setEMarketingSpotId

public void setEMarketingSpotId(java.lang.String eMarketingSpotId)
This method provides access to the EMSPOT.EMSPOT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of this e-marketing spot.

Parameters:
java.lang.String -  

setInitKey__eMarketingSpotId

public void setInitKey__eMarketingSpotId(java.lang.String newEMarketingSpotId)
Set the primary key for this object.
Parameters:
newEMarketingSpotId - - the reference number of the e-marketing spot

setName

public void setName(java.lang.String name)
This method provides access to the EMSPOT.NAME column of DB2 type VARCHAR(64) NOT NULL.

The following is a description of this column:

The name of this e-marketing spot.

Parameters:
java.lang.String -  

setStoreId

public void setStoreId(java.lang.Integer storeId)
This method provides access to the EMSPOT.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of the store in which this e-marketing spot belongs to. This field is a foreign key to the STOREENT table.

Parameters:
java.lang.Integer -  

setStoreId

public void setStoreId(java.lang.String storeId)
This method provides access to the EMSPOT.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of the store in which this e-marketing spot belongs to. This field is a foreign key to the STOREENT table.

Parameters:
java.lang.String -  

setSupportedTypes

public void setSupportedTypes(java.lang.String supportedTypes)
This method provides access to the EMSPOT.SUPPORTEDTYPES column of DB2 type VARCHAR(20) NULL.

The following is a description of this column:

The supported types of this e-marketing spot.

Parameters:
java.lang.String -