com.ibm.commerce.order.beans

Class OrderItemAdjustmentDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.order.objects.OrderItemAdjustmentAccessBean

com.ibm.commerce.order.beansrc.OrderItemAdjustmentDataBeanBase

com.ibm.commerce.order.beans.OrderItemAdjustmentDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, com.ibm.commerce.order.beans.OrderItemAdjustmentInputDataBean, com.ibm.commerce.order.beans.OrderItemAdjustmentSmartDataBean, Delegator, java.io.Serializable

public class OrderItemAdjustmentDataBean
extends OrderItemAdjustmentDataBeanBase
implements com.ibm.commerce.order.beans.OrderItemAdjustmentInputDataBean, com.ibm.commerce.order.beans.OrderItemAdjustmentSmartDataBean

This databean represents an OrderItemAdjustment object.

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
OrderItemAdjustmentDataBean() Constructs an OrderItemAdjustmentDataBean.
OrderItemAdjustmentDataBean(OrderItemAdjustmentAccessBean aabOrderItemAdjustment) Constructs an OrderItemAdjustmentDataBean from an OrderItemAdjustmentAccessBean by extracting the OrderItemAdjustment Entity reference from the OrderItemAdjustmentAccessBean.

Method Summary

Modifier and Type	Method and Description
CalculationCodeDataBean	getCalculationCodeDataBean() This method returns the CalculationCodeDataBean (indirectly) associated with this OrderItemAdjustment.
CalculationCodeDescriptionDataBean	getCalculationCodeDescriptionDataBean() This method returns the CalculationCodeDescriptionDataBean of the CalculationCodeDataBean (indirectly) associated with this OrderItemAdjustment corresponding to the current Language and Store.
java.lang.String	getCalculationCodeDescriptionString() This method returns the description string of the CalculationCodeDataBean (indirectly) associated with this OrderItemAdjustment corresponding to the current Language and Store.
java.lang.String	getCalculationCodeLongDescriptionString() This method returns the long description string of the CalculationCodeDataBean (indirectly) associated with this OrderItemAdjustment corresponding to the current Language and Store.
CommandContext	getCommandContext() This method returns the command context set within this bean.
java.lang.String	getDataBeanKeyOrderItemAdjustmentId() This method returns order item adjustment id.
FormattedMonetaryAmountDataBean	getFormattedAmount() This method returns the formatted amount of this OrderItemAdjustment.
OrderAdjustmentDataBean	getOrderAdjustmentDataBean() This method returns the OrderAdjustmentDataBean associated with this OrderItemAdjustment.
OrderAdjustmentDescriptionDataBean	getOrderAdjustmentDescriptionDataBean() This method returns the OrderAdjustmentDescriptionDataBean of the OrderAdjustmentDataBean associated with this OrderItemAdjustment that corresponds to the current Language and Store.
java.lang.String	getOrderAdjustmentDescriptionString() This method returns the description string of the OrderAdjustmentDataBean associated with this OrderItemAdjustment that corresponds to the current Language and Store.
OrderItemDataBean	getOrderItemDataBean() This method returns the OrderItemDataBean associated with this OrderItemAdjustment.
TypedProperty	getRequestProperties() This method returns the request property set within this bean.
void	populate() This method is used to populate the OrderItemAdjustmentDataBean.
void	setCommandContext(CommandContext aCommandContext) This method sets the command context within this bean.
void	setDataBeanKeyOrderItemAdjustmentId(java.lang.String aOrderItemAdjustmentId) This method sets order item adjustment id.
void	setRequestProperties(TypedProperty aRequestProperty) This method sets the request property within this bean.

Methods inherited from class com.ibm.commerce.order.beansrc.OrderItemAdjustmentDataBeanBase

getDelegate

Methods inherited from class com.ibm.commerce.order.objects.OrderItemAdjustmentAccessBean

findByOrderAdjustment, findByOrderAdjustmentForUpdate, findByOrderId, findByOrderIdAndCalculationUsageId, findByOrderItem, findByOrderItemAndCalculationUsageId, findByOrderItemIds, getAmount, getAmountInEntityType, getEntity, getOrderAdjustmentId, getOrderAdjustmentIdInEntityType, getOrderItemAdjustmentId, getOrderItemAdjustmentIdInEntityType, getOrderItemId, getOrderItemIdInEntityType, instantiateEntity, setAmount, setAmount, setInitKey_orderItemAdjustmentId, setInitKey_orderItemAdjustmentId, setOrderAdjustmentId, setOrderAdjustmentId, setOrderItemId, setOrderItemId

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 IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

OrderItemAdjustmentDataBean

public OrderItemAdjustmentDataBean()

Constructs an OrderItemAdjustmentDataBean.

OrderItemAdjustmentDataBean

public OrderItemAdjustmentDataBean(OrderItemAdjustmentAccessBean aabOrderItemAdjustment)

Constructs an OrderItemAdjustmentDataBean from an OrderItemAdjustmentAccessBean by extracting the OrderItemAdjustment Entity reference from the OrderItemAdjustmentAccessBean.

Parameters:

aabOrderItemAdjustment - OrderItemAdjustmentAccessBean

Throws:

java.lang.Exception

Method Detail

getRequestProperties

public TypedProperty getRequestProperties()

This method returns the request property set within this bean.

Specified by:

getRequestProperties in interface InputDataBean

Returns:

com.ibm.commerce.datatype.TypedProperty

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperty)

This method sets the request property within this bean.

Specified by:

setRequestProperties in interface InputDataBean

Parameters:

aRequestProperty - TypedProperty

getDataBeanKeyOrderItemAdjustmentId

public java.lang.String getDataBeanKeyOrderItemAdjustmentId()

This method returns order item adjustment id.

Specified by:

getDataBeanKeyOrderItemAdjustmentId in interface com.ibm.commerce.order.beans.OrderItemAdjustmentSmartDataBean

Returns:

java.lang.String

getCommandContext

public CommandContext getCommandContext()

This method returns the command context set within this bean.

Specified by:

getCommandContext in interface SmartDataBean

Returns:

com.ibm.commerce.command.CommandContext

setCommandContext

public void setCommandContext(CommandContext aCommandContext)

This method sets the command context within this bean.

Specified by:

setCommandContext in interface SmartDataBean

Parameters:

aCommandContext - com.ibm.commerce.command.CommandContext

setDataBeanKeyOrderItemAdjustmentId

public void setDataBeanKeyOrderItemAdjustmentId(java.lang.String aOrderItemAdjustmentId)

This method sets order item adjustment id.

Specified by:

setDataBeanKeyOrderItemAdjustmentId in interface com.ibm.commerce.order.beans.OrderItemAdjustmentInputDataBean

Parameters:

aOrderItemAdjustmentId - java.lang.String

populate

public void populate()

This method is used to populate the OrderItemAdjustmentDataBean. You must set OrderItemAdjustmentId using the setDataBeanKeyOrderItemAdjustmentId method before running the populate() method.

Specified by:

populate in interface SmartDataBean

Throws:

java.lang.Exception

See Also:

setDataBeanKeyOrderItemAdjustmentId(String)

getOrderAdjustmentDataBean

public OrderAdjustmentDataBean getOrderAdjustmentDataBean()

This method returns the OrderAdjustmentDataBean associated with this OrderItemAdjustment.

Returns:

the OrderAdjustmentDataBean, or null if an error has occurred during its retrieval.

getOrderAdjustmentDescriptionDataBean

public OrderAdjustmentDescriptionDataBean getOrderAdjustmentDescriptionDataBean()

This method returns the OrderAdjustmentDescriptionDataBean of the OrderAdjustmentDataBean associated with this OrderItemAdjustment that corresponds to the current Language and Store. Equivalent to getOrderAdjustmentDataBean().getDescriptionDataBean().

Returns:

the OrderAdjustmentDescriptionDataBean, or null if none is found or an error has occurred during its retrieval.

getOrderAdjustmentDescriptionString

public java.lang.String getOrderAdjustmentDescriptionString()

This method returns the description string of the OrderAdjustmentDataBean associated with this OrderItemAdjustment that corresponds to the current Language and Store. Equivalent to getOrderAdjustmentDescriptionDataBean().getDescription().

Returns:

the OrderAdjustmentDescriptionDataBean, or null if none is found or an error has occurred during its retrieval.

getCalculationCodeDataBean

public CalculationCodeDataBean getCalculationCodeDataBean()

This method returns the CalculationCodeDataBean (indirectly) associated with this OrderItemAdjustment. Equivalent to getOrderAdjustmentDataBean().getCalculationCodeDataBean().

Returns:

the CalculationCodeDataBean, or null if none is found or an error has occurred during its retrieval.

getCalculationCodeDescriptionDataBean

public CalculationCodeDescriptionDataBean getCalculationCodeDescriptionDataBean()

This method returns the CalculationCodeDescriptionDataBean of the CalculationCodeDataBean (indirectly) associated with this OrderItemAdjustment corresponding to the current Language and Store. Equivalent to getCalculationCodeDataBean().getDescriptionDataBean().

Returns:

the CalculationCodeDescriptionDataBean, or null if none is found or an error has occurred during its retrieval.

getCalculationCodeDescriptionString

public java.lang.String getCalculationCodeDescriptionString()

This method returns the description string of the CalculationCodeDataBean (indirectly) associated with this OrderItemAdjustment corresponding to the current Language and Store. Equivalent to getCalculationCodeDataBean().getDescriptionString().

Returns:

the description string, or null if none is found or an error has occurred during its retrieval.

getCalculationCodeLongDescriptionString

public java.lang.String getCalculationCodeLongDescriptionString()

This method returns the long description string of the CalculationCodeDataBean (indirectly) associated with this OrderItemAdjustment corresponding to the current Language and Store. Equivalent to getCalculationCodeDataBean().getLongDescriptionString().

Returns:

the long description string, or null if none is found or an error has occurred during its retrieval.

getOrderItemDataBean

public OrderItemDataBean getOrderItemDataBean()

This method returns the OrderItemDataBean associated with this OrderItemAdjustment.

Returns:

the OrderItemDataBean, or null if an error has occurred during its retrieval.

getFormattedAmount

public FormattedMonetaryAmountDataBean getFormattedAmount()

This method returns the formatted amount of this OrderItemAdjustment.

Returns:

the formatted amount, or null if an error has occurred.

See Also:

OrderItemAdjustmentAccessBean.getAmountInEntityType()