com.ibm.commerce.catalog.beans

Class CatalogDescriptionDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.catalog.objects.CatalogDescriptionAccessBean

com.ibm.commerce.catalog.beansrc.CatalogDescriptionDataBeanBase

com.ibm.commerce.catalog.beans.CatalogDescriptionDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, com.ibm.commerce.catalog.beans.CatalogDescriptionInputDataBean, com.ibm.commerce.catalog.beans.CatalogDescriptionSmartDataBean, Delegator, java.io.Serializable

public class CatalogDescriptionDataBean
extends com.ibm.commerce.catalog.beansrc.CatalogDescriptionDataBeanBase
implements com.ibm.commerce.catalog.beans.CatalogDescriptionInputDataBean, com.ibm.commerce.catalog.beans.CatalogDescriptionSmartDataBean

This is the catalog description data bean. This data bean contains information such as name and description for a catalog. This data bean maps to the CATALOGDSC database table.

You can find more information about data beans in the WebSphere Commerce data beans topic in the Information Center.

Access Beans: CatalogDescription

Mandatory Parameters (for single row retrieval):

• catalog reference number, language ID

Some hints and tips for using this data bean are:

• It is important to set the catalog reference number, and language ID values before activating the data bean
• You can set parameters using the setters

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The internal copyright field.

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
CatalogDescriptionDataBean()

Method Summary

Modifier and Type	Method and Description
CommandContext	getCommandContext() Gets the command context set within this bean.
java.lang.String	getDataBeanKeyCatalogReferenceNumber() Gets the catalog reference number.
java.lang.String	getDataBeanKeyLanguage_id() Gets the language ID.
TypedProperty	getRequestProperties() Gets the request property set within this bean.
void	populate() Loads data into the data bean when the DataBeanManager.activate() runs.
void	setCommandContext(CommandContext aCommandContext) Sets the command context within this bean.
void	setDataBeanKeyCatalogReferenceNumber(java.lang.String aCatalogReferenceNumber) Sets the catalog reference number.
void	setDataBeanKeyLanguage_id(java.lang.String aLanguage_id) Sets the language ID for the attribute.
void	setRequestProperties(TypedProperty aRequestProperty) Sets the request property within this bean.

Methods inherited from class com.ibm.commerce.catalog.beansrc.CatalogDescriptionDataBeanBase

getDelegate

Methods inherited from class com.ibm.commerce.catalog.objects.CatalogDescriptionAccessBean

findByCatalogId, findByCatalogIdNoCache, findByCatalogIdsAndLanguageId, findByCatalogIdsAndLanguageIdEnumeration, findByCatalogIdsAndLanguageIdNoCache, getCatalogReferenceNumber, getEntity, getFullIImage, getLanguage_id, getLanguage_idInEntityType, getLongDescription, getName, getShortDescription, getThumbNail, instantiateEntity, setCatalogReferenceNumber, setFullIImage, setInitKey_catalogReferenceNumber, setInitKey_catalogReferenceNumber, setInitKey_language_id, setInitKey_language_id, setLanguage_id, setLanguage_id, setLongDescription, setName, setShortDescription, setThumbNail

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, remove, setUseDataCache, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The internal copyright field.

See Also:

Constant Field Values

Constructor Detail

CatalogDescriptionDataBean

public CatalogDescriptionDataBean()

Method Detail

getRequestProperties

public TypedProperty getRequestProperties()

Gets the request property set within this bean.

Specified by:

getRequestProperties in interface InputDataBean

Returns:

The request property as TypedProperty object.

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperty)

Sets the request property within this bean. The following values are set in this method: catalog reference number language ID

Specified by:

setRequestProperties in interface InputDataBean

Parameters:

The - request property as TypedProperty object.

Throws:

RemoteException - In the execution of the method, a remote exception occurs.

FinderException - In the execution of the method, a finder exception occurs.

NamingException - In the execution of the method, a naming exception occurs.

CreateException - In the execution of the method, a create exception occurs.

getDataBeanKeyCatalogReferenceNumber

public java.lang.String getDataBeanKeyCatalogReferenceNumber()

Gets the catalog reference number.

Specified by:

getDataBeanKeyCatalogReferenceNumber in interface com.ibm.commerce.catalog.beans.CatalogDescriptionSmartDataBean

Returns:

The catalog reference number.

getDataBeanKeyLanguage_id

public java.lang.String getDataBeanKeyLanguage_id()

Gets the language ID.

Specified by:

getDataBeanKeyLanguage_id in interface com.ibm.commerce.catalog.beans.CatalogDescriptionSmartDataBean

Returns:

The language ID.

getCommandContext

public CommandContext getCommandContext()

Gets the command context set within this bean.

Specified by:

getCommandContext in interface SmartDataBean

Returns:

The command context as CommandContext object.

setCommandContext

public void setCommandContext(CommandContext aCommandContext)

Sets the command context within this bean.

Specified by:

setCommandContext in interface SmartDataBean

Parameters:

aCommandContext - The command context as CommandContext object.

setDataBeanKeyCatalogReferenceNumber

public void setDataBeanKeyCatalogReferenceNumber(java.lang.String aCatalogReferenceNumber)

Sets the catalog reference number.

Specified by:

setDataBeanKeyCatalogReferenceNumber in interface com.ibm.commerce.catalog.beans.CatalogDescriptionInputDataBean

Parameters:

aCatalogReferenceNumber - The catalog reference number.

setDataBeanKeyLanguage_id

public void setDataBeanKeyLanguage_id(java.lang.String aLanguage_id)

Sets the language ID for the attribute. The language ID value must be equal to an entry in the LANGUAGE database table.

Specified by:

setDataBeanKeyLanguage_id in interface com.ibm.commerce.catalog.beans.CatalogDescriptionInputDataBean

Parameters:

aLanguage_id - The language ID.

populate

public void populate()

Loads data into the data bean when the DataBeanManager.activate() runs.

Specified by:

populate in interface SmartDataBean

Throws:

java.lang.Exception