com.ibm.commerce.order.beans

Class ShipInstructionsDataBean

    • Field Detail

      • COPYRIGHT

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

      • ShipInstructionsDataBean

        public ShipInstructionsDataBean()
        ShippingInstructionDataBean constructor.
      • ShipInstructionsDataBean

        public ShipInstructionsDataBean(ShipInfoAccessBean shipInfoAccessBean,
                                        CommandContext aCommandContext)
        Constructs a ShipInstructionsDataBean from a ShipInfoAccessBean by extracting the ShipInfo EJB reference from the ShippingInstructionAccessBean and setting the commandContext
        Parameters:
        shipInfoAccessBean - ShipInfoAccessBean
        aCommandContext - Command Context
        Throws:
        java.lang.Exception
      • ShipInstructionsDataBean

        public ShipInstructionsDataBean(ShipInfoAccessBean shipInfoAccessBean)
        Constructs an ShipInstructionsDataBean from an ShipInfoAccessBean by extracting the ShipInfo EJB reference from the ShippingInstructionAccessBean. Note: Consider using ShipInstructionsDataBean(ShipInfoAccessBean, CommandContext) if commandContext is available.
        Parameters:
        shipInfoAccessBean - ShipInfoAccessBean
        Throws:
        java.lang.Exception
    • Method Detail

      • setDataBeanKeyShipInfoId

        public void setDataBeanKeyShipInfoId(java.lang.String aShipInfoID)
        This method sets the SHIPINFO ID of the primary key.
        Parameters:
        aShipInfoID - the ShipInfo key
      • setCommandContext

        public void setCommandContext(CommandContext context)
        This method sets the CommandContext method comment.
        Specified by:
        setCommandContext in interface SmartDataBean
        Parameters:
        context - CommandContext
      • 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 aRequestProperties)
        This method sets the request properties within this bean.
        Specified by:
        setRequestProperties in interface InputDataBean
        Parameters:
        aRequestProperties - com.ibm.commerce.datatype.TypedProperty
      • populate

        public void populate()
        This method is used to populate the ShipInstructionsDataBean. You must set ShipInfoId using the setDataBeanKeyShipInfoId method before running the populate() method.
        Specified by:
        populate in interface SmartDataBean
        Throws:
        java.lang.Exception
        See Also:
        setDataBeanKeyShipInfoId(String)
      • getIRequestProperties

        public TypedProperty getIRequestProperties()
        This method returns the request properties.
        Returns:
        iRequestProperties
      • setIRequestProperties

        public void setIRequestProperties(TypedProperty property)
        This method sets the request properties.
        Parameters:
        property - TypedProperty
      • getShipInstructionsDB

        public ShipInstructionsDataBean getShipInstructionsDB(java.lang.String orderId,
                                                              java.lang.String addressId,
                                                              java.lang.String shipModeId)
        This method returns a ShipInstructionsDataBean object based on the parameters passed in.
        Parameters:
        orderId - the order ID of the shipping instructions data to read
        addressId - the address ID of the shipping instructions data to read
        shipModeId - the ship mode of the shipping instructions data to read
        Returns:
        ShipInstructionsDataBean A databean holding shipping instructions data
      • getShipInstructions

        public java.lang.String getShipInstructions()
        This method returns the shipping instructions of this ShipInstructionsDataBean object.
        Returns:
        String the shipping instructions
      • getOrderID

        public java.lang.String getOrderID()
        This method returns the order ID of this ShipInstructionsDataBean object.
        Returns:
        String the order ID
      • getAddressID

        public java.lang.String getAddressID()
        This method returns the address ID of this ShipInstructionsDataBean object.
        Returns:
        String the address ID
      • getShipModeID

        public java.lang.String getShipModeID()
        This method returns the ship mode ID of this ShipInstructionsDataBean object.
        Returns:
        String the ship mode ID