com.ibm.commerce.tools.contract.beans

Class AddressListDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.tools.contract.beans.AddressListDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, java.io.Serializable


    public class AddressListDataBean
    extends com.ibm.commerce.beans.SmartDataBeanImpl
    This data bean is used to get a list of AddressDataBean. For example, if there are 3 addresses belong to a member, the data bean will get a list of these 3 address data beans. A member can be a user, a group of users, or an organizational entity. Member identifier is a prerequisite parameter that need to be set before populate. When listing the addresses belonging to a member, the data bean will be called.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.user.beans.AddressDataBean[] getAddressList()
      Gets the list of addresses belonging to a member
      void populate()
      This method is used to get the list of addresses belonging to a member.
      void setAddressType(java.lang.String addressType)
      Sets the address type
      void setMemberId(java.lang.Long memberId)
      Sets the member identifier
      • 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

      • FIND_BY_ADDRESS_TYPE

        public static final java.lang.String FIND_BY_ADDRESS_TYPE
        The find by constants
        See Also:
        Constant Field Values
      • FIND_BY_MEMBER_ID

        public static final java.lang.String FIND_BY_MEMBER_ID
        The find by constants
        See Also:
        Constant Field Values
      • ORDER_BY_LAST_NAME

        public static final java.lang.String ORDER_BY_LAST_NAME
        See Also:
        Constant Field Values
      • ORDER_BY_NICK_NAME

        public static final java.lang.String ORDER_BY_NICK_NAME
        See Also:
        Constant Field Values
      • PARAMETER_FIND_BY

        public static final java.lang.String PARAMETER_FIND_BY
        The order by constants
        See Also:
        Constant Field Values
      • PARAMETER_ORDER_BY

        public static final java.lang.String PARAMETER_ORDER_BY
        The order by constants
        See Also:
        Constant Field Values
      • TYPE_BILLTO

        public static final java.lang.String TYPE_BILLTO
        The ship to constants
        See Also:
        Constant Field Values
      • TYPE_DONE

        public static final java.lang.String TYPE_DONE
        The ship to constants
        See Also:
        Constant Field Values
      • TYPE_SHIPTO

        public static final java.lang.String TYPE_SHIPTO
        The ship to constants
        See Also:
        Constant Field Values
      • TYPE_SHIPTO_BILLTO

        public static final java.lang.String TYPE_SHIPTO_BILLTO
        The ship to constants
        See Also:
        Constant Field Values
    • Constructor Detail

      • AddressListDataBean

        public AddressListDataBean()
    • Method Detail

      • getAddressList

        public com.ibm.commerce.user.beans.AddressDataBean[] getAddressList()
        Gets the list of addresses belonging to a member
        Returns:
        java.lang.String
      • populate

        public void populate()
                      throws java.lang.Exception
        This method is used to get the list of addresses belonging to a member. Loads data into the data bean when the DataBeanManager.activate() runs.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        Throws:
        java.lang.Exception
      • setAddressType

        public void setAddressType(java.lang.String addressType)
        Sets the address type
        Parameters:
        addressType - String valid values are P (primary address book) or S (secondary address book).
      • setMemberId

        public void setMemberId(java.lang.Long memberId)
        Sets the member identifier
        Parameters:
        memberId - Long the member who owns this address book.