com.ibm.commerce.marketingcenter.campaign.objects
Class CollateralAccessBean

java.lang.Object
  com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
      com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
Direct Known Subclasses:
CollateralDataBean

public class CollateralAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean

This table contains data describing the advertisements used by marketing campaigns. This access bean corresponds to the database table 'COLLATERAL'.

See Also:
Serialized Form

Constructor Summary
CollateralAccessBean()
Zero argument constructor used to initialize the access bean.
CollateralAccessBean(java.lang.Integer arg1, java.lang.String arg2, java.lang.Integer arg3, java.lang.Integer arg4)
Maps to a corresponding ejbCreate method in the home interface of the EJB.
CollateralAccessBean(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)
This finder returns all the collateral in an enumeration with the given store reference number.
CollateralAccessBean findByStoreAndName(java.lang.Integer storeId, java.lang.String name)
This finder returns the collateral in a bean with the given store reference number and the collateral name.
java.util.Enumeration findByStoreAndType(java.lang.Integer storeId, java.lang.Integer type)
This finder returns all the collateral in an enumeration with the given store and collateral type reference number.
java.util.Enumeration findByStoreAndTypeWithOrder(java.lang.Integer storeId, java.lang.Integer typeId, java.lang.String orderCol, java.lang.Integer languageId)
This finder returns all the collateral in an enumeration with the given store and collateral type reference number, sorted by the given column.
java.util.Enumeration findByStoreSortedByName(java.lang.Integer storeId)
This finder returns all the collateral in an enumeration with the given store reference number, sorted by name.
java.util.Enumeration findByStoreSortedByType(java.lang.Integer storeId)
This finder returns all the collateral in an enumeration with the given store reference number, sorted by the collateral type.
java.util.Enumeration findByStoreWithOrder(java.lang.Integer storeId, java.lang.String orderCol, java.lang.Integer languageId)
This finder returns all the collateral in an enumeration with the given store reference number, sorted by the given column.
boolean fulfills(java.lang.Long arg0, java.lang.String arg1)
java.lang.String getCollateralId()
This method provides access to the COLLATERAL.COLLATERAL_ID column of DB2 type INTEGER NOT NULL.
java.lang.Integer getCollateralIdInEJBType()
This method provides access to the COLLATERAL.COLLATERAL_ID column of DB2 type INTEGER NOT NULL.
java.lang.String getCustomerField1()
This method provides access to the COLLATERAL.FIELD1 column of DB2 type VARCHAR(254).
java.lang.String getCustomerField2()
This method provides access to the COLLATERAL.FIELD2 column of DB2 type VARCHAR(254).
java.lang.String getName()
This method provides access to the COLLATERAL.NAME column of DB2 type VARCHAR(30).
java.lang.Long getOwner()
This method accesses a non-CMP field
java.lang.String getStoreId()
This method provides access to the COLLATERAL.STOREENT_ID column of DB2 type INTEGER NOT NULL.
java.lang.Integer getStoreIdInEJBType()
This method provides access to the COLLATERAL.STOREENT_ID column of DB2 type INTEGER NOT NULL.
java.lang.String getType()
This method provides access to the COLLATERAL.COLLTYPE_ID column of DB2 type INTEGER NOT NULL.
java.lang.Integer getTypeInEJBType()
This method provides access to the COLLATERAL.COLLTYPE_ID column of DB2 type INTEGER NOT NULL.
java.lang.String getUrlLink()
This method provides access to the COLLATERAL.URL column of DB2 type VARCHAR(254).
protected void instantiateEJB()
protected boolean instantiateEJBByPrimaryKey()
void refreshCopyHelper()
Load data from the EJBObject.
void setCollateralId(java.lang.Integer newValue)
This method accesses a non-CMP field
void setCollateralId(java.lang.String newValue)
This method accesses a non-CMP field
void setCustomerField1(java.lang.String newValue)
This method accesses a non-CMP field
void setCustomerField2(java.lang.String newValue)
This method accesses a non-CMP field
void setInitKey_collateralId(java.lang.String newValue)
Set the primary key for this object
void setName(java.lang.String newValue)
This method accesses a non-CMP field
void setStoreId(java.lang.Integer newValue)
This method accesses a non-CMP field
void setStoreId(java.lang.String newValue)
This method accesses a non-CMP field
void setType(java.lang.Integer newValue)
This method accesses a non-CMP field
void setType(java.lang.String newValue)
This method accesses a non-CMP field
void setUrlLink(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

CollateralAccessBean

public CollateralAccessBean()
Zero argument constructor used to initialize the access bean. This constructor corresponds to the following home interface method: public abstract com.ibm.commerce.marketingcenter.campaign.objects.Collateral com.ibm.commerce.marketingcenter.campaign.objimpl.CollateralHomeBase.findByPrimaryKey(com.ibm.commerce.marketingcenter.campaign.objects.CollateralKey) 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_collateralId( java.lang.Integer )

CollateralAccessBean

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

CollateralAccessBean

public CollateralAccessBean(java.lang.Integer arg1,
                            java.lang.String arg2,
                            java.lang.Integer arg3,
                            java.lang.Integer arg4)
                     throws javax.ejb.CreateException,
                            java.rmi.RemoteException,
                            javax.naming.NamingException
Maps to a corresponding ejbCreate method in the home interface of the EJB.
Parameters:
arg1 - - the internal reference number of the collateral
arg2 - - the name of the collateral
arg3 - - the internal reference number of the store
arg4 - - the internal reference number of the collateral type
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
Method Detail

findByStoreAndName

public CollateralAccessBean findByStoreAndName(java.lang.Integer storeId,
                                               java.lang.String name)
                                        throws java.rmi.RemoteException,
                                               javax.ejb.FinderException,
                                               javax.naming.NamingException
This finder returns the collateral in a bean with the given store reference number and the collateral name.

SQL:

SELECT * FROM COLLATERAL T1 WHERE (T1.STOREENT_ID = storeId AND T1.NAME = name)

Parameters:
storeId - - the reference number of the store
name - - the name of the collateral
Returns:
com.ibm.commerce.marketingcenter.campaign.objects.Collateral - the returned collateral
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

findByStore

public java.util.Enumeration findByStore(java.lang.Integer storeId)
                                  throws java.rmi.RemoteException,
                                         javax.ejb.FinderException,
                                         javax.naming.NamingException
This finder returns all the collateral in an enumeration with the given store reference number.

SQL:

SELECT * FROM COLLATERAL T1 WHERE (T1.STOREENT_ID = storeId)

Parameters:
storeId - - the internal reference number of the store
Returns:
java.util.Enumeration - all the returned collateral
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

findByStoreAndType

public java.util.Enumeration findByStoreAndType(java.lang.Integer storeId,
                                                java.lang.Integer type)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.FinderException,
                                                javax.naming.NamingException
This finder returns all the collateral in an enumeration with the given store and collateral type reference number.

SQL:

SELECT * FROM COLLATERAL T1 WHERE (T1.STOREENT_ID = storeId AND T1.TYPE = type)

Parameters:
storeId - - the internal reference number of the store
type - - the internal reference number of the collateral type
Returns:
java.util.Enumeration - all the returned collateral
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

findByStoreAndTypeWithOrder

public java.util.Enumeration findByStoreAndTypeWithOrder(java.lang.Integer storeId,
                                                         java.lang.Integer typeId,
                                                         java.lang.String orderCol,
                                                         java.lang.Integer languageId)
                                                  throws java.rmi.RemoteException,
                                                         javax.ejb.FinderException,
                                                         javax.naming.NamingException
This finder returns all the collateral in an enumeration with the given store and collateral type reference number, sorted by the given column.

SQL:

SELECT * FROM COLLATERAL T1, COLLDESC T2 WHERE T1.STOREENT_ID = storeId AND T1.COLLTYPE_ID = typeId AND T2.LANGUAGE_ID = languageId AND T2.COLLATERAL_ID = T1.COLLATERAL_ID ORDER BY orderCol

Parameters:
storeId - - the internal reference number of the store
typeId - - the internal reference number of the collateral type
orderCol - - the name of the column that will be sorted
languageId - - the internal reference number of the language
Returns:
java.util.Enumeration - all the returned collateral
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

findByStoreSortedByName

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

SQL:

SELECT * FROM COLLATERAL 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 collateral
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

findByStoreSortedByType

public java.util.Enumeration findByStoreSortedByType(java.lang.Integer storeId)
                                              throws java.rmi.RemoteException,
                                                     javax.ejb.FinderException,
                                                     javax.naming.NamingException
This finder returns all the collateral in an enumeration with the given store reference number, sorted by the collateral type.

SQL:

SELECT * FROM COLLATERAL T1 WHERE (T1.STOREENT_ID = storeId) order by T1.COLLTYPE_ID

Parameters:
storeId - - the internal reference number of the store
Returns:
java.util.Enumeration - all the returned collateral
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

findByStoreWithOrder

public java.util.Enumeration findByStoreWithOrder(java.lang.Integer storeId,
                                                  java.lang.String orderCol,
                                                  java.lang.Integer languageId)
                                           throws java.rmi.RemoteException,
                                                  javax.ejb.FinderException,
                                                  javax.naming.NamingException
This finder returns all the collateral in an enumeration with the given store reference number, sorted by the given column.

SQL:

SELECT * FROM COLLATERAL T1, COLLDESC T2 WHERE T1.STOREENT_ID = storeId AND T2.LANGUAGE_ID = languageId AND T2.COLLATERAL_ID = T1.COLLATERAL_ID ORDER BY orderCol

Parameters:
storeId - - the internal reference number of the store
orderCol - - the name of the column that will be sorted
languageId - - the internal reference number of the language
Returns:
java.util.Enumeration - all the returned collateral
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

setInitKey_collateralId

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

getCollateralId

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

This method provides access to the COLLATERAL.COLLATERAL_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of the Collateral.

Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getCollateralIdInEJBType

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

This method provides access to the COLLATERAL.COLLATERAL_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The internal reference number of the Collateral.

Returns:
java.lang.Integer
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setCollateralId

public void setCollateralId(java.lang.String newValue)
This method accesses a non-CMP field

setCollateralId

public void setCollateralId(java.lang.Integer newValue)
This method accesses a non-CMP field

getUrlLink

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

This method provides access to the COLLATERAL.URL column of DB2 type VARCHAR(254).

The following is a description of this column:

The click action to be invoked when the Collateral on the page is clicked.

Returns:
java.lang.String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setUrlLink

public void setUrlLink(java.lang.String newValue)
This method accesses a non-CMP field

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 COLLATERAL.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The ID of the store to which the Collateral belongs.

Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

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 COLLATERAL.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The ID of the store to which the Collateral belongs.

Returns:
java.lang.Integer
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setStoreId

public void setStoreId(java.lang.String newValue)
This method accesses a non-CMP field

setStoreId

public void setStoreId(java.lang.Integer newValue)
This method accesses a non-CMP field

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 COLLATERAL.COLLTYPE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Foreign key to the COLLTYPE table. Identifies the type of Collateral. The supported default types are Image, Flash, and Text.

Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getTypeInEJBType

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

This method provides access to the COLLATERAL.COLLTYPE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Foreign key to the COLLTYPE table. Identifies the type of Collateral. The supported default types are Image, Flash, and Text.

Returns:
java.lang.Integer
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setType

public void setType(java.lang.String newValue)
This method accesses a non-CMP field

setType

public void setType(java.lang.Integer newValue)
This method accesses a non-CMP field

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 COLLATERAL.NAME column of DB2 type VARCHAR(30).

The following is a description of this column:

The name of the Collateral.

Returns:
java.lang.String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setName

public void setName(java.lang.String newValue)
This method accesses a non-CMP field

getCustomerField2

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

This method provides access to the COLLATERAL.FIELD2 column of DB2 type VARCHAR(254).

The following is a description of this column:

Customizable.

Returns:
java.lang.String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setCustomerField2

public void setCustomerField2(java.lang.String newValue)
This method accesses a non-CMP field

getCustomerField1

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

This method provides access to the COLLATERAL.FIELD1 column of DB2 type VARCHAR(254).

The following is a description of this column:

Customizable.

Returns:
java.lang.String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setCustomerField1

public void setCustomerField1(java.lang.String newValue)
This method accesses a non-CMP field

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
Parameters:
arg0 - java.lang.Long
arg1 - java.lang.String
Returns:
boolean
Throws:
java.rmi.RemoteException
java.lang.Exception
javax.ejb.FinderException
javax.naming.NamingException

getOwner

public java.lang.Long getOwner()
                        throws java.lang.Exception,
                               java.rmi.RemoteException,
                               javax.ejb.FinderException,
                               javax.naming.NamingException
This method accesses a non-CMP field
Throws:
java.lang.Exception
java.rmi.RemoteException
javax.ejb.FinderException
javax.naming.NamingException

Feedback