com.ibm.commerce.order.beans

Class OrderAdjustmentDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, com.ibm.commerce.order.beans.OrderAdjustmentInputDataBean, com.ibm.commerce.order.beans.OrderAdjustmentSmartDataBean, Delegator, java.io.Serializable

    public class OrderAdjustmentDataBean
extends OrderAdjustmentDataBeanBase
implements com.ibm.commerce.order.beans.OrderAdjustmentInputDataBean, com.ibm.commerce.order.beans.OrderAdjustmentSmartDataBean
    This databean represents an OrderAdjustment object.
    See Also:
    Serialized Form

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The IBM copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • OrderAdjustmentDataBean

        public OrderAdjustmentDataBean()
        Constructs an OrderAdjustmentDataBean.

      • OrderAdjustmentDataBean

        public OrderAdjustmentDataBean(OrderAdjustmentAccessBean aabOrderAdjustment)
        Constructs an OrderAdjustmentDataBean from an OrderAdjustmentAccessBean by extracting the OrderAdjustment Entity reference from the OrderAdjustmentAccessBean.
        Parameters:
        aabOrderAdjustment - com.ibm.commerce.order.objects.OrderAdjustmentAccessBean
        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 - com.ibm.commerce.datatype.TypedProperty

      • getDataBeanKeyOrderAdjustmentId

        public java.lang.String getDataBeanKeyOrderAdjustmentId()
        This method returns order adjustment id.
        Specified by:
        getDataBeanKeyOrderAdjustmentId in interface com.ibm.commerce.order.beans.OrderAdjustmentSmartDataBean
        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

      • setDataBeanKeyOrderAdjustmentId

        public void setDataBeanKeyOrderAdjustmentId(java.lang.String aOrderAdjustmentId)
        This method sets order adjustment id.
        Specified by:
        setDataBeanKeyOrderAdjustmentId in interface com.ibm.commerce.order.beans.OrderAdjustmentInputDataBean
        Parameters:
        aOrderAdjustmentId - java.lang.String

      • populate

        public void populate()
        This method is used to populate the OrderAdjustmentDataBean. You must set the OrderAdjustmentId using the setDataBeanKeyOrderAdjustmentId method before running the populate() method.
        Specified by:
        populate in interface SmartDataBean
        Throws:
        java.lang.Exception
        See Also:
        setDataBeanKeyOrderAdjustmentId(String)

      • getDescriptionDataBean

        public OrderAdjustmentDescriptionDataBean getDescriptionDataBean()
        This method 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()
        This method 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()
        This method returns the CalculationCodeDataBean associated with this OrderAdjustment.
        Returns:
        the CalculationCodeDataBean, 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 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()
        This method 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()
        This method returns the OrderDataBean associated with this OrderAdjustment.
        Returns:
        the OrderDataBean, or if an error has occurred during its retrieval.
Skip navigation links