com.ibm.commerce.catalog.beans

Class AttributeDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.catalog.objects.AttributeAccessBean

com.ibm.commerce.catalog.beans.AttributeDataBean

All Implemented Interfaces:

java.io.Serializable

public class AttributeDataBean
extends AttributeAccessBean

This bean represents an attribute of a catalog entry. For example, if the catalog entry is an item that is a shirt, then a possible attribute may be the colour of the shirt. The attribute can be a descriptive attribute or a defining attribute. Defining attributes are used for SKU resolution, and descriptive attributes are not used for SKU resolution.

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

Access Beans: Attribute

Mandatory Parameters (for single row retrieval):

• attribute ID

Some hints and tips for using this data bean are:

• It is important to set the attribute ID value before activating the data bean
• You can set parameters using the constructor, or the setters

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The internal copyright field.
java.lang.String	istrAttributeId The attribute ID.
java.lang.String	istrCatalogEntryId The catalog entry ID in which the attribute belongs to.
java.lang.String	istrName The attribute name.

Constructor Summary

Constructors

Constructor and Description
AttributeDataBean() Creates an empty AttributeDataBean.
AttributeDataBean(AttributeAccessBean abAttribute) Constructor of AttributeDataBean using an AttributeAccessBean.
AttributeDataBean(AttributeAccessBean abAttribute, CommandContext aCommandContext) Constructor of AttributeDataBean using an AttributeAccessBean and a CommandContext.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeId() Gets the attribute ID.
AttributeValueDataBean[]	getAttributeValueDataBeans() Gets a list of the AttributeValueDataBean for the attribute.
java.lang.String	getCatalogEntryId() Gets the catalog entry ID.
java.lang.String	getLanguageId() The language ID of the attribute.
java.lang.String	getName() Gets the attribute name.
boolean	isDefiningAttribute() Determines whether the attribute is a defining attribute.
void	populate() Loads data into the data bean when the DataBeanManager.activate() runs.
void	setAttributeId(java.lang.String newAttributeId) Sets the attribute ID of the attribute.
void	setCatalogEntryId(java.lang.String newCatalogEntryId) Sets the catalog entry ID to which the attributes belong.
void	setCommandContext(CommandContext aCommandContext) Sets the CommandContext.
void	setLanguageId(java.lang.String newLanguageId) Sets the language ID for the attribute.
void	setName(java.lang.String newName) Sets the attribute name.

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

findByAttributeId, findByCatalogEntryId, findByCatEntryLanguageAndSequence, findByCatEntryLanguageAndUsage, findByNameAndCatalogEntryAndLanguage, findByProduct, getAttributeReferenceNumber, getAttributeReferenceNumberInEntityType, getAttributeType, getAttributeValues, getAttributeValues, getAttributeValues, getCatalogEntryReferenceNumber, getCatalogEntryReferenceNumberInEntityType, getDescription, getDescription2, getDistinctAttributeValues, getEntity, getField1, getGroupName, getLanguage_id, getLanguage_idInEntityType, getMaxSequenceForCatEntryAndLanguage, getNoteInfo, getOID, getSequenceNumber, getSequenceNumberInEntityType, getUsage, instantiateEntity, setAttributeReferenceNumber, setAttributeReferenceNumber, setAttributeType, setCatalogEntryReferenceNumber, setCatalogEntryReferenceNumber, setDescription, setDescription2, setField1, setGroupName, setInitKey_attributeReferenceNumber, setInitKey_attributeReferenceNumber, setInitKey_language_id, setInitKey_language_id, setLanguage_id, setLanguage_id, setNoteInfo, setOID, setSequenceNumber, setSequenceNumber, setUsage

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

istrAttributeId

public java.lang.String istrAttributeId

The attribute ID.

istrName

public java.lang.String istrName

The attribute name.

istrCatalogEntryId

public java.lang.String istrCatalogEntryId

The catalog entry ID in which the attribute belongs to.

Constructor Detail

AttributeDataBean

public AttributeDataBean(AttributeAccessBean abAttribute)

Constructor of AttributeDataBean using an AttributeAccessBean.

Parameters:

abAttribute - the AttributeAccessBean for the attribute

AttributeDataBean

public AttributeDataBean(AttributeAccessBean abAttribute,
                         CommandContext aCommandContext)

Constructor of AttributeDataBean using an AttributeAccessBean and a CommandContext.

Parameters:

abAttribute - the AttributeAccessBean for the attribute

aCommandContext - the CommandContext

AttributeDataBean

public AttributeDataBean()

Creates an empty AttributeDataBean.

Method Detail

getAttributeId

public java.lang.String getAttributeId()

Gets the attribute ID. An attribute is a property of a catalog entry.

Returns:

attribute ID

getCatalogEntryId

public java.lang.String getCatalogEntryId()

Gets the catalog entry ID.

Returns:

catalog entry ID

getLanguageId

public java.lang.String getLanguageId()

The language ID of the attribute.

Returns:

language ID

getName

public java.lang.String getName()

Gets the attribute name.

Overrides:

getName in class AttributeAccessBean

Returns:

attribute name

populate

public void populate()
              throws java.lang.Exception

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

Throws:

java.lang.Exception

setAttributeId

public void setAttributeId(java.lang.String newAttributeId)

Sets the attribute ID of the attribute.

Parameters:

newAttributeId - attribute ID

setCommandContext

public void setCommandContext(CommandContext aCommandContext)

Sets the CommandContext.

Parameters:

aCommandContext - the CommandContext

setCatalogEntryId

public void setCatalogEntryId(java.lang.String newCatalogEntryId)

Sets the catalog entry ID to which the attributes belong.

Parameters:

newCatalogEntryId - catalog entry ID

setLanguageId

public void setLanguageId(java.lang.String newLanguageId)

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

Parameters:

newLanguageId - the language ID.

setName

public void setName(java.lang.String newName)

Sets the attribute name.

Overrides:

setName in class AttributeAccessBean

Parameters:

newName - name of the attribute

getAttributeValueDataBeans

public AttributeValueDataBean[] getAttributeValueDataBeans()

Gets a list of the AttributeValueDataBean for the attribute. An attribute is the property of a catalog entry; the attribute value is the possible property values. For example, the attribute may be size and the attribute values may be small, medium, and large. If there are no attribute value data beans to return this method will return a zero length array.

Returns:

The list of AttributeValueDataBean.

isDefiningAttribute

public boolean isDefiningAttribute()

Determines whether the attribute is a defining attribute. Defining attributes are properties of SKUs in an online store, such as color or size. Attribute values are the property of an attribute such as a specific color (blue or yellow) or size (medium). You must predefine attribute values before assigning them to SKUs. Attribute values are implicitly related to their attributes. Each possible combination of attributes and attribute values equals a new SKU.

Returns:

true if the attribute is a defining attribute