com.ibm.commerce.fulfillment.beans

Class CalculationCodeListDataBean

java.lang.Object

com.ibm.commerce.beans.InputDataBeanImpl

com.ibm.commerce.beans.SmartDataBeanImpl

com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, Delegator, java.io.Serializable

public class CalculationCodeListDataBean
extends SmartDataBeanImpl
implements Delegator

This databean is used to retrieve the list of CalculationCodeDataBean that matches the specified set of criteria. Null valued parameters are ignored unless specified otherwise.

See Also:

Serialized Form

Field Summary

Fields

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

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

emptyString

Constructor Summary

Constructors

Constructor and Description
CalculationCodeListDataBean() The Constructor for CalculationCodeListDataBean.

Method Summary

Modifier and Type	Method and Description
CalculationCodeDataBean[]	getCalculationCodeDataBeans() This method returns the list of CalculationCodeDataBeans that matches the specified set of criteria.
java.util.Vector	getCategories(java.lang.Integer storeId, CatalogEntryAccessBean catEntBean) This method returns the category ids of all CatalogGroupAccessBean which associated with the specified catalog entry.
Protectable	getDelegate() Returns the Protectable object whose access control policies will indirectly control the access control for this object
boolean	getIncludeParentProduct() This method gets whether to retrieve the CalculationCodes attached to the parent product of the specified CatalogEntry.
java.util.Vector	getMemberGroups(UserAccessBean currentUser, CommandContext commandContext, java.lang.Integer storeID) This method returns all the segments and convert to Vector.
java.util.Vector	getParentCategories(java.lang.Integer storeId, java.lang.Long catGrpId) This method returns a Vector of all parent CatalogGroup IDs which associated with this category.
CatalogEntryAccessBean	getProduct(java.lang.Long catEntryId) This method returns a catalogEntryAccessBean which specifies the product.
void	populate() This method is used to populate the CalculationCodeListDataBean.
void	setAllowUnentitledPromotionsByMemberGroup(boolean abAllowUnentitledPromotionsByMemberGroup) This method sets whether to include promotions that are targeted to a member group if the user does not belong to the member group.
void	setAllowUnentitledPromotionsByMemberGroup(java.lang.String astrAllowUnentitledPromotionsByMemberGroup) This method sets whether to include promotions that are targeted to a member group if the user does not belong to the member group.
void	setAttachedToAllCatalogEntries(boolean abAttachedToAllCatalogEntries) This method sets whether the CalculationCodes are attached to all CatalogEntries.
void	setAttachedToAllCatalogEntries(java.lang.String astrAttachedToAllCatalogEntries) This method sets whether the CalculationCodes are attached to all CatalogEntries.
void	setCalculationUsageId(java.lang.Integer anCalculationUsageId) This method sets the CalculationUsage of the CalculationCodes.
void	setCalculationUsageId(java.lang.String astrCalculationUsageId) This method sets the CalculationUsage of the CalculationCodes.
void	setCatalogEntryId(java.lang.Long anCatalogEntryId) This method sets the CatalogEntry that the CalculationCodes are attached to.
void	setCatalogEntryId(java.lang.String astrCatalogEntryId) This method sets the CatalogEntry that the CalculationCodes are attached to.
void	setCatalogGroupId(java.lang.Long anCatalogGroupId) This method sets the CatalogGroup that the CalculationCodes are attached to.
void	setCatalogGroupId(java.lang.String astrCatalogGroupId) This method sets the CatalogGroup that the CalculationCodes are attached to.
void	setCode(java.lang.String astrCode) This method sets the code (a-k-a name) of the CalculationCodes.
void	setDisplayLevel(java.lang.Integer anDisplayLevel) This method sets the display level of the CalculationCodes.
void	setDisplayLevel(java.lang.String astrDisplayLevel) This method sets the display level of the CalculationCodes.
void	setExcludePromotionCode(boolean abExcludePromotionCode) This method sets whether to retrieve the CalculationCodes which requires promotion code.
void	setExcludePromotionCode(java.lang.String astrExcludePromotionCode) This method sets whether to retrieve the CalculationCodes which requires promotion code
void	setIncludeChildItems(boolean abIncludeChildItems) This method sets whether to retrieve the CalculationCodes attached to the child items of the specified CatalogEntry.
void	setIncludeChildItems(java.lang.String astrIncludeChildItems) This method sets whether to retrieve the CalculationCodes attached to the child items of the specified CatalogEntry.
void	setIncludeParentCategory(boolean abIncludeParentCategories) This method sets whether to retrieve the CalculationCodes attached to the parent categories of the specified CatalogGroup .
void	setIncludeParentCategory(java.lang.String astrIncludeParentCategories) This method sets whether to retrieve the CalculationCodes attached to the parent categories of the specified CatalogGroup.
void	setIncludeParentProduct(boolean abIncludeParentProduct) This method sets whether to retrieve the CalculationCodes attached to the parent product of the specified CatalogEntry.
void	setIncludeParentProduct(java.lang.String astrIncludeParentProduct) This method sets whether to retrieve the CalculationCodes attached to the parent product of the specified CatalogEntry.
void	setInShipmodeId(java.lang.Integer newInShipmodeId) This method sets the inShipmodeId.
void	setInShipmodeId(java.lang.String newInShipmodeId) This method sets the shipmode .
void	setIsProdPromoOnly(boolean newState) This method sets the flag for excluding category promotions.
void	setIsProdPromoOnly(java.lang.String strState) This method sets the flag for excluding category promotions.
void	setOnlyManagementCenterPromotions(boolean abOnlyManagementCenterPromotions) This method sets whether all the promotions in the store have been created in Management Center.
void	setOnlyManagementCenterPromotions(java.lang.String astrOnlyManagementCenterPromotions) This method sets whether all the promotions in the store have been created in Management Center.
void	setStoreId(java.lang.Integer newStoreId) This method sets the store ID from the JSP, this store ID could be the parent store.
void	setStoreId(java.lang.String newStrStoreId) Set the store ID by the String parameter passed from JSP
void	setStorePathEnabled(boolean isStorePathEnabled) This method sets the boolean value to true if the data bean search Calculation Code based on store path.
void	setStorePathEnabled(java.lang.String astrIsStorePathEnabled) This method sets the String value to true if the data bean search Calculation Code based on store path.
void	setUserId(java.lang.Long newInUserId) This method sets the user ID.
void	setUserId(java.lang.String sInUserId) This method sets the user ID.

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

getRequestProperties, setRequestProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

getRequestProperties, setRequestProperties

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

CalculationCodeListDataBean

public CalculationCodeListDataBean()

The Constructor for CalculationCodeListDataBean.

Method Detail

setCalculationUsageId

public void setCalculationUsageId(java.lang.Integer anCalculationUsageId)

This method sets the CalculationUsage of the CalculationCodes.

Parameters:

anCalculationUsageId - the CalculationUsage ID.

setCalculationUsageId

public void setCalculationUsageId(java.lang.String astrCalculationUsageId)

This method sets the CalculationUsage of the CalculationCodes.

Parameters:

astrCalculationUsageId - the CalculationUsage ID.

setDisplayLevel

public void setDisplayLevel(java.lang.Integer anDisplayLevel)

This method sets the display level of the CalculationCodes.

Parameters:

anDisplayLevel - the display level.

setDisplayLevel

public void setDisplayLevel(java.lang.String astrDisplayLevel)

This method sets the display level of the CalculationCodes.

Parameters:

astrDisplayLevel - the display level.

setCatalogEntryId

public void setCatalogEntryId(java.lang.Long anCatalogEntryId)

This method sets the CatalogEntry that the CalculationCodes are attached to. Overrides #setCatalogGroupId(Long)setCatalogGroupId()and .

Parameters:

anCatalogEntryId - the CatalogEntry ID.

setCatalogEntryId

public void setCatalogEntryId(java.lang.String astrCatalogEntryId)

This method sets the CatalogEntry that the CalculationCodes are attached to. Overrides #setCatalogGroupId(String)setCatalogGroupId()and .

Parameters:

astrCatalogEntryId - the CatalogEntry ID.

setCatalogGroupId

public void setCatalogGroupId(java.lang.Long anCatalogGroupId)

This method sets the CatalogGroup that the CalculationCodes are attached to. Overrides .

Parameters:

anCatalogGroupId - the CatalogGroup ID.

setCatalogGroupId

public void setCatalogGroupId(java.lang.String astrCatalogGroupId)

This method sets the CatalogGroup that the CalculationCodes are attached to. Overrides .

Parameters:

astrCatalogGroupId - the CatalogGroup ID.

setAttachedToAllCatalogEntries

public void setAttachedToAllCatalogEntries(boolean abAttachedToAllCatalogEntries)

This method sets whether the CalculationCodes are attached to all CatalogEntries.

Parameters:

abAttachedToAllCatalogEntries - whether the CalculationCodes are attached to all CatalogEntries. Default is false.

setAttachedToAllCatalogEntries

public void setAttachedToAllCatalogEntries(java.lang.String astrAttachedToAllCatalogEntries)

This method sets whether the CalculationCodes are attached to all CatalogEntries.

Parameters:

astrAttachedToAllCatalogEntries - whether the CalculationCodes are attached to all CatalogEntries. Default is false.

setIncludeParentProduct

public void setIncludeParentProduct(boolean abIncludeParentProduct)

This method sets whether to retrieve the CalculationCodes attached to the parent product of the specified CatalogEntry. Overrides #setIncludeChildItems(boolean)setIncludeChildItems().

Parameters:

abIncludeParentProduct - whether to include the parent product. Default is false.

getIncludeParentProduct

public boolean getIncludeParentProduct()

This method gets whether to retrieve the CalculationCodes attached to the parent product of the specified CatalogEntry.

Returns:

ibIncludeParentProduct

setIncludeParentProduct

public void setIncludeParentProduct(java.lang.String astrIncludeParentProduct)

This method sets whether to retrieve the CalculationCodes attached to the parent product of the specified CatalogEntry. Overrides #setIncludeChildItems(String)setIncludeChildItems().

Parameters:

astrIncludeParentProduct - whether to include the parent product. Default is false.

setIncludeChildItems

public void setIncludeChildItems(boolean abIncludeChildItems)

This method sets whether to retrieve the CalculationCodes attached to the child items of the specified CatalogEntry.

Parameters:

abIncludeChildItems - whether to include the child items. Default is false.

setIncludeChildItems

public void setIncludeChildItems(java.lang.String astrIncludeChildItems)

This method sets whether to retrieve the CalculationCodes attached to the child items of the specified CatalogEntry.

Parameters:

astrIncludeChildItems - whether to include the child items. Default is false.

setIncludeParentCategory

public void setIncludeParentCategory(boolean abIncludeParentCategories)

This method sets whether to retrieve the CalculationCodes attached to the parent categories of the specified CatalogGroup .

Parameters:

abIncludeParentCategories - whether to include the parent categories. Default is false.

setIncludeParentCategory

public void setIncludeParentCategory(java.lang.String astrIncludeParentCategories)

This method sets whether to retrieve the CalculationCodes attached to the parent categories of the specified CatalogGroup.

Parameters:

astrIncludeParentCategories - whether to include the parent categories. Default is false.

setCode

public void setCode(java.lang.String astrCode)

This method sets the code (a-k-a name) of the CalculationCodes.

Parameters:

astrCode - the code.

setOnlyManagementCenterPromotions

public void setOnlyManagementCenterPromotions(boolean abOnlyManagementCenterPromotions)

This method sets whether all the promotions in the store have been created in Management Center. If you can indicate that all the promotions in the store have been created in Management Center, then setting this parameter to true can improve performance by avoiding this check.

Parameters:

abOnlyManagementCenterPromotions - The setting whether all the promotions in the store have been created in Management Center. The default value if this parameter is not set is false.

setOnlyManagementCenterPromotions

public void setOnlyManagementCenterPromotions(java.lang.String astrOnlyManagementCenterPromotions)

This method sets whether all the promotions in the store have been created in Management Center. If you can indicate that all the promotions in the store have been created in Management Center, then setting this parameter to true can improve performance by avoiding this check.

Parameters:

astrOnlyManagementCenterPromotions - The setting whether all the promotions in the store have been created in Management Center. The default value if this parameter is not set is false.

setAllowUnentitledPromotionsByMemberGroup

public void setAllowUnentitledPromotionsByMemberGroup(boolean abAllowUnentitledPromotionsByMemberGroup)

This method sets whether to include promotions that are targeted to a member group if the user does not belong to the member group. If you do not use member group targeted promotions, then setting this parameter to true can improve performance by avoiding this check.

Parameters:

abAllowUnentitledPromotionsByMemberGroup - The setting to include promotions that are targeted to a member group if the user does not belong to the member group. The default value if this parameter is not set is false.

setAllowUnentitledPromotionsByMemberGroup

public void setAllowUnentitledPromotionsByMemberGroup(java.lang.String astrAllowUnentitledPromotionsByMemberGroup)

This method sets whether to include promotions that are targeted to a member group if the user does not belong to the member group. If you do not use member group targeted promotions, then setting this parameter to true can improve performance by avoiding this check.

Parameters:

astrAllowUnentitledPromotionsByMemberGroup - The setting include promotions that are targeted to a member group if the user does not belong to the member group. The default value if this parameter is not set is false.

setExcludePromotionCode

public void setExcludePromotionCode(boolean abExcludePromotionCode)

This method sets whether to retrieve the CalculationCodes which requires promotion code.

Parameters:

abExcludePromotionCode - whether to exclude the promotion code required promotion. Default is true.

setExcludePromotionCode

public void setExcludePromotionCode(java.lang.String astrExcludePromotionCode)

This method sets whether to retrieve the CalculationCodes which requires promotion code

Parameters:

astrExcludePromotionCode - whether to exclude the promotion code required promotion. Default is true.

setStoreId

public void setStoreId(java.lang.Integer newStoreId)

This method sets the store ID from the JSP, this store ID could be the parent store.

Parameters:

newStoreId -

setStoreId

public void setStoreId(java.lang.String newStrStoreId)

Set the store ID by the String parameter passed from JSP

Parameters:

newStrStoreId -

setStorePathEnabled

public void setStorePathEnabled(boolean isStorePathEnabled)

This method sets the boolean value to true if the data bean search Calculation Code based on store path. Otherwise, sets to false. If sets to false, the databean will only return the calculation code within current store. Default value is true

Parameters:

isStorePathEnabled - boolean.

setStorePathEnabled

public void setStorePathEnabled(java.lang.String astrIsStorePathEnabled)

This method sets the String value to true if the data bean search Calculation Code based on store path. Otherwise, sets to false. If sets to false, the databean will only return the calculation code within current store. Default value is true

Parameters:

astrIsStorePathEnabled - java.lang.String.

populate

public void populate()
              throws java.lang.Exception

This method is used to populate the CalculationCodeListDataBean.

Specified by:

populate in interface SmartDataBean

Overrides:

populate in class SmartDataBeanImpl

Throws:

java.lang.Exception

getCalculationCodeDataBeans

public CalculationCodeDataBean[] getCalculationCodeDataBeans()

This method returns the list of CalculationCodeDataBeans that matches the specified set of criteria.

Returns:

the CalculationCodeDataBeans.

setInShipmodeId

public void setInShipmodeId(java.lang.Integer newInShipmodeId)

This method sets the inShipmodeId.

Parameters:

newInShipmodeId - shipModeId.

setInShipmodeId

public void setInShipmodeId(java.lang.String newInShipmodeId)

This method sets the shipmode .

Parameters:

newInShipmodeId - shipModeId.

setUserId

public void setUserId(java.lang.Long newInUserId)

This method sets the user ID.

Parameters:

newInUserId - userId.

setUserId

public void setUserId(java.lang.String sInUserId)

This method sets the user ID.

Parameters:

sInUserId - userId.

setIsProdPromoOnly

public void setIsProdPromoOnly(boolean newState)

This method sets the flag for excluding category promotions.

Parameters:

newState - ProdPromoOnly.

setIsProdPromoOnly

public void setIsProdPromoOnly(java.lang.String strState)

This method sets the flag for excluding category promotions.

Parameters:

strState - ProdPromoOnly.

getCategories

public java.util.Vector getCategories(java.lang.Integer storeId,
                                      CatalogEntryAccessBean catEntBean)
                               throws java.lang.Exception

This method returns the category ids of all CatalogGroupAccessBean which associated with the specified catalog entry. This association also contains CatalogGroup' parent-child relationship.

Parameters:

storeId - Integer

catEntBean - CatalogEntryAccessBean

Returns:

the category ids. Each element is a String.

Throws:

java.lang.Exception

getParentCategories

public java.util.Vector getParentCategories(java.lang.Integer storeId,
                                            java.lang.Long catGrpId)
                                     throws java.lang.Exception

This method returns a Vector of all parent CatalogGroup IDs which associated with this category.

Parameters:

storeId - Integer

catGrpId - Long

Returns:

Vector

Throws:

java.lang.Exception

getProduct

public CatalogEntryAccessBean getProduct(java.lang.Long catEntryId)

This method returns a catalogEntryAccessBean which specifies the product.

Parameters:

catEntryId - Long.

Returns:

com.ibm.commerce.catalog.objects.CatalogEntryAccessBean.

getMemberGroups

public java.util.Vector getMemberGroups(UserAccessBean currentUser,
                                        CommandContext commandContext,
                                        java.lang.Integer storeID)
                                 throws ECException

This method returns all the segments and convert to Vector.

Parameters:

currentUser - com.ibm.commerce.user.objects.UserAccessBean.

commandContext - CommandContext.

storeID - java.lang.Integer.

Returns:

Vector.

Throws:

ECException

getDelegate

public Protectable getDelegate()
                        throws java.lang.Exception

Description copied from interface: Delegator

Returns the Protectable object whose access control policies will indirectly control the access control for this object

Specified by:

getDelegate in interface Delegator

Returns:

The Protectable object whose access control policies will indirectly control the access control for this object

Throws:

java.lang.Exception