com.ibm.commerce.catalog.beans

Class InterestItemListDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.catalog.objects.InterestItemListAccessBean

com.ibm.commerce.catalog.beansrc.InterestItemListDataBeanBase

com.ibm.commerce.catalog.beans.InterestItemListDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, com.ibm.commerce.catalog.beans.InterestItemListInputDataBean, com.ibm.commerce.catalog.beans.InterestItemListSmartDataBean, Delegator, Protectable, java.io.Serializable

public class InterestItemListDataBean
extends com.ibm.commerce.catalog.beansrc.InterestItemListDataBeanBase
implements com.ibm.commerce.catalog.beans.InterestItemListInputDataBean, com.ibm.commerce.catalog.beans.InterestItemListSmartDataBean

The bean represents an interest list for a user. This bean maps to the IITEMLIST database table.

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

Access Beans: InterestItemList

Some hints and tips for using this data bean are:

• 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.

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

emptyString

Constructor Summary

Constructors

Constructor and Description
InterestItemListDataBean() InterestItemListDataBean default constructor.
InterestItemListDataBean(InterestItemListAccessBean abList, CommandContext c) InterestItemListDataBean constructor.

Method Summary

Modifier and Type	Method and Description
CommandContext	getCommandContext() Gets the command context.
InterestItemDataBean[]	getInterestItemDataBeans() Returns the array of InterestItemDataBeans
InterestItemDataBean	getItem(int index) Gets the interest item at the specified index.
java.lang.String	getListId() Gets the list ID of the InterestItemList.
int	getNumOfItems() Gets the number of the interest items in the list.
TypedProperty	getRequestProperties() Gets the request properties.
boolean	isCurrentList() Checks if this list is the current list for the user as defined in CIITEMLIST database table.
void	populate() Loads data into the data bean when the DataBeanManager.activate() runs.
void	setCommandContext(CommandContext commandContext) Sets the command context.
void	setItem(int index, InterestItemDataBean item) Sets the specified interest item at the specified position in the list.
void	setListId(java.lang.String newList_rn) Sets the primary key for the list.
void	setRequestProperties(TypedProperty param) Sets the request properties.
void	setStoreEntityId(java.lang.Integer storeEntityId) Sets the store entity id on the bean.

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

getDelegate

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

addInterestItem, addToCurrentUserList, findByMaximumDisplaySequenceNumber, findCurrentListsForUser, findListsForUser, findNewestListForUser, findWithPushDownQuery, fulfills, getDescription, getDisplaySequenceNumber, getDisplaySequenceNumberInEntityType, getEntity, getInterestItems, getInterestListNumber, getInterestListNumberInEntityType, getLastChangeTime, getLastChangeTimeInEntityType, getOwner, getUserReferenceNumber, getUserReferenceNumberInEntityType, instantiateEntity, removeFromCurrentUserList, removeInterestItem, setDescription, setDisplaySequenceNumber, setDisplaySequenceNumber, setInitKey_interestListNumber, setInitKey_interestListNumber, setInterestListNumber, setInterestListNumber, setLastChangeTime, setLastChangeTime, setUserReferenceNumber, setUserReferenceNumber

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

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The internal copyright field.

See Also:

Constant Field Values

Constructor Detail

InterestItemListDataBean

public InterestItemListDataBean()

InterestItemListDataBean default constructor.

InterestItemListDataBean

public InterestItemListDataBean(InterestItemListAccessBean abList,
                                CommandContext c)

InterestItemListDataBean constructor.

Parameters:

abList - the primary key of the interest item list

c - the command context

Method Detail

getCommandContext

public CommandContext getCommandContext()

Gets the command context.

Specified by:

getCommandContext in interface SmartDataBean

Returns:

the command context

getItem

public InterestItemDataBean getItem(int index)

Gets the interest item at the specified index.

Specified by:

getItem in interface com.ibm.commerce.catalog.beans.InterestItemListSmartDataBean

Returns:

the interest item

getListId

public java.lang.String getListId()

Gets the list ID of the InterestItemList.

Specified by:

getListId in interface com.ibm.commerce.catalog.beans.InterestItemListSmartDataBean

Returns:

the primary key of the interest item list

getNumOfItems

public int getNumOfItems()

Gets the number of the interest items in the list.

Specified by:

getNumOfItems in interface com.ibm.commerce.catalog.beans.InterestItemListSmartDataBean

Returns:

the number of items in the list

getRequestProperties

public TypedProperty getRequestProperties()

Gets the request properties.

Specified by:

getRequestProperties in interface InputDataBean

Returns:

the request properties

isCurrentList

public boolean isCurrentList()

Checks if this list is the current list for the user as defined in CIITEMLIST database table.

Specified by:

isCurrentList in interface com.ibm.commerce.catalog.beans.InterestItemListSmartDataBean

Returns:

true if it is the current list for the user; false otherwise

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

setCommandContext

public void setCommandContext(CommandContext commandContext)

Sets the command context.

Specified by:

setCommandContext in interface SmartDataBean

Parameters:

commandContext - the command context

setItem

public void setItem(int index,
                    InterestItemDataBean item)

Sets the specified interest item at the specified position in the list.

Specified by:

setItem in interface com.ibm.commerce.catalog.beans.InterestItemListInputDataBean

Parameters:

index - the position of insertion

item - the interest item to be inserted

setListId

public void setListId(java.lang.String newList_rn)

Sets the primary key for the list.

Specified by:

setListId in interface com.ibm.commerce.catalog.beans.InterestItemListInputDataBean

Parameters:

newList_rn - the primary key of the list

setRequestProperties

public void setRequestProperties(TypedProperty param)

Sets the request properties.

Specified by:

setRequestProperties in interface InputDataBean

Parameters:

param - the request properties

getInterestItemDataBeans

public InterestItemDataBean[] getInterestItemDataBeans()

Returns the array of InterestItemDataBeans

Returns:

the array of InterestItemDataBeans

setStoreEntityId

public void setStoreEntityId(java.lang.Integer storeEntityId)

Sets the store entity id on the bean. To scope the InterestItemListDataBean results to only contain Interest Items for the current store, set this id BEFORE activation.

Parameters:

storeEntityId - the store entity id that the list of interest items should be applied to.