com.ibm.commerce.order.beans
Class OrderAdjustmentDataBean

java.lang.Object
  |
  +--com.ibm.commerce.order.beansrc.OrderAdjustmentDataBeanBase
        |
        +--com.ibm.commerce.order.beans.OrderAdjustmentDataBean

public class OrderAdjustmentDataBean
extends com.ibm.commerce.order.beansrc.OrderAdjustmentDataBeanBase

IBM internal use only.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright
protected  CommandContext iCommandContext
          command context
protected  java.lang.String iDataBeanKeyOrderAdjustmentId
          order adjustment id
protected  TypedProperty iRequestProperties
          request properties
 
Constructor Summary
OrderAdjustmentDataBean()
          Constructs an OrderAdjustmentDataBean.
OrderAdjustmentDataBean( OrderAdjustmentAccessBean aabOrderAdjustment)
          Constructs an OrderAdjustmentDataBean from an OrderAdjustmentAccessBean by extracting the OrderAdjustment EJB reference from the OrderAdjustmentAccessBean.
 
Method Summary
  CalculationCodeDataBean getCalculationCodeDataBean()
          Returns the CalculationCodeDataBean associated with this OrderAdjustment.
  CalculationCodeDescriptionDataBean getCalculationCodeDescriptionDataBean()
          Returns the CalculationCodeDescriptionDataBean of the CalculationCodeDataBean associated with this OrderAdjustment that corresponds to the current Language and Store.
 java.lang.String getCalculationCodeDescriptionString()
          Returns the description string of the CalculationCodeDataBean associated with this OrderAdjustment that corresponds to the current Language and Store.
 java.lang.String getCalculationCodeLongDescriptionString()
          Returns the long description string of the CalculationCodeDataBean associated with this OrderAdjustment that corresponds to the current Language and Store.
  CommandContext getCommandContext()
          Gets the command context set within this bean.
 java.lang.String getDataBeanKeyOrderAdjustmentId()
          Gets order adjustment id
  OrderAdjustmentDescriptionDataBean getDescriptionDataBean()
          Returns the OrderAdjustmentDescriptionDataBean of this OrderAdjustment that corresponds to the current Language and Store.
 java.lang.String getDescriptionString()
          Returns the description string of this OrderAdjustment that corresponds to the current Language and Store.
  FormattedMonetaryAmountDataBean getFormattedAmount()
          Returns the formatted amount of this OrderAdjustment.
  OrderDataBean getOrderDataBean()
          Returns the OrderDataBean associated with this OrderAdjustment.
  TypedProperty getRequestProperties()
          Gets the request property set within this bean.
 void populate()
          Retrieves data from the database.
 void setCommandContext( CommandContext aCommandContext)
          Sets the command context within this bean.
 void setDataBeanKeyOrderAdjustmentId(java.lang.String aOrderAdjustmentId)
          Sets order adjustment id
 void setRequestProperties( TypedProperty aRequestProperty)
          Sets the request property within this bean.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright
See Also:
Constant Field Values

iCommandContext

protected CommandContext iCommandContext
command context

iRequestProperties

protected TypedProperty iRequestProperties
request properties

iDataBeanKeyOrderAdjustmentId

protected java.lang.String iDataBeanKeyOrderAdjustmentId
order adjustment id
Constructor Detail

OrderAdjustmentDataBean

public OrderAdjustmentDataBean()
Constructs an OrderAdjustmentDataBean.

OrderAdjustmentDataBean

public OrderAdjustmentDataBean(OrderAdjustmentAccessBean aabOrderAdjustment)
                        throws java.lang.Exception
Constructs an OrderAdjustmentDataBean from an OrderAdjustmentAccessBean by extracting the OrderAdjustment EJB reference from the OrderAdjustmentAccessBean.
Parameters:
aabOrderAdjustment - com.ibm.commerce.order.objects.OrderAdjustmentAccessBean
Throws:
java.lang.Exception
Method Detail

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request property set within this bean.
Returns:
com.ibm.commerce.datatype.TypedProperty

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperty)
                          throws javax.ejb.CreateException,
                                 java.rmi.RemoteException,
                                 javax.naming.NamingException,
                                 javax.ejb.FinderException
Sets the request property within this bean.
Parameters:
aRequestProperty - com.ibm.commerce.datatype.TypedProperty
Throws:
javax.ejb.CreateException
java.rmi.RemoteException
javax.naming.NamingException
javax.ejb.FinderException

getDataBeanKeyOrderAdjustmentId

public java.lang.String getDataBeanKeyOrderAdjustmentId()
Gets order adjustment id
Returns:
java.lang.String

getCommandContext

public CommandContext getCommandContext()
Gets the command context set within this bean.
Returns:
com.ibm.commerce.command.CommandContext

setCommandContext

public void setCommandContext(CommandContext aCommandContext)
Sets the command context within this bean.
Parameters:
aCommandContext - com.ibm.commerce.command.CommandContext

setDataBeanKeyOrderAdjustmentId

public void setDataBeanKeyOrderAdjustmentId(java.lang.String aOrderAdjustmentId)
Sets order adjustment id
Parameters:
aOrderAdjustmentId - java.lang.String

populate

public void populate()
              throws java.lang.Exception
Retrieves data from the database.
Throws:
java.lang.Exception

getDescriptionDataBean

public OrderAdjustmentDescriptionDataBean getDescriptionDataBean()
Returns the OrderAdjustmentDescriptionDataBean of this OrderAdjustment that corresponds to the current Language and Store.
Returns:
the OrderAdjustmentDescriptionDataBean, or null if none is found or an error has occurred during its retrieval.

getDescriptionString

public java.lang.String getDescriptionString()
Returns the description string of this OrderAdjustment that corresponds to the current Language and Store. Equivalent to getDescriptionDataBean().getDescription().
Returns:
the description string, or null if none is found or an error has occurred during its retrieval.

getCalculationCodeDataBean

public CalculationCodeDataBean getCalculationCodeDataBean()
Returns the CalculationCodeDataBean associated with this OrderAdjustment.
Returns:
the CalculationCodeDataBean, or null if none is found or an error has occurred during its retrieval.

getCalculationCodeDescriptionDataBean

public CalculationCodeDescriptionDataBean getCalculationCodeDescriptionDataBean()
Returns the CalculationCodeDescriptionDataBean of the CalculationCodeDataBean associated with this OrderAdjustment that corresponds 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()
Returns the description string of the CalculationCodeDataBean associated with this OrderAdjustment that corresponds 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()
Returns the long description string of the CalculationCodeDataBean associated with this OrderAdjustment that corresponds 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.

getOrderDataBean

public OrderDataBean getOrderDataBean()
Returns the OrderDataBean associated with this OrderAdjustment.
Returns:
the OrderDataBean, or if an error has occurred during its retrieval.

getFormattedAmount

public FormattedMonetaryAmountDataBean getFormattedAmount()
Returns the formatted amount of this OrderAdjustment.
Returns:
the formatted amount, or null if an error has occurred.
See Also:
OrderAdjustmentAccessBean.getAmountInEJBType()