com.ibm.commerce.user.beans

Class AddressDataBean

  • java.lang.Object
    • com.ibm.commerce.user.beans.AddressDataBean
  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, Delegator, com.ibm.commerce.user.beans.AddressInputDataBean, com.ibm.commerce.user.beans.AddressSmartDataBean, java.io.Serializable


    public class AddressDataBean
    extends java.lang.Object
    implements com.ibm.commerce.user.beans.AddressInputDataBean, com.ibm.commerce.user.beans.AddressSmartDataBean, Delegator
    The data bean representing an address.

    The following code can be used to create and activate an AddressDataBean:

           AddressDataBean bnAddress = new AddressDataBean();
           com.ibm.commerce.beans.DataBeanManager.activate(bnAddress, request, response);
     
    The AddressDataBean will try to get the addressId and nickName parameters from request.
    • If addressId is not null, it will find the address using the addressId.
    • If addressId is null, it will find the address using the memberId and nickName.
    Users can also directly call setAddressId(String), setMemberId(String), and setNickName(String) methods to set addressId, memberId and nickName directly, overwriting the values from the request.
    To find the address using the addressId, use the following code:
           AddressDataBean bnAddress = new AddressDataBean();
           bnAddress.setAddressId(addressId);
           com.ibm.commerce.beans.DataBeanManager.activate(bnAddress, request, response);
     

    To find the address using the memberId and nickName, use the following code:
           AddressDataBean bnAddress = new AddressDataBean();
           bnAddress.setMemberId(memberId);
           bnAddress.setNickName(nickName);
           com.ibm.commerce.beans.DataBeanManager.activate(bnAddress, request, response);
     
    If the specified address is found, the findAddress() method will return true, otherwise it will return false.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CLASSNAME
      The fully qualified name of this class.
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
    • Constructor Summary

      Constructors 
      Constructor and Description
      AddressDataBean()
      The default constructor for AddressDataBean.
      AddressDataBean(java.lang.String astrAddressId)
      The constructor for AddressDataBean.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      boolean findAddress()
      Returns a boolean value indicating whether the address is found according to addressId or specified nickName .
      java.lang.String getAddress1()
      Gets the first line of the address.
      java.lang.String getAddress1URL()
      Gets the name of Address1 url parameter.
      java.lang.String getAddress2()
      Gets the second line of the address.
      java.lang.String getAddress2URL()
      Gets the name of Address2 url parameter.
      java.lang.String getAddress3()
      Gets the third line of the address.
      java.lang.String getAddress3URL()
      Gets the name of Address3 url parameter.
      java.lang.String getAddressField1()
      Gets the name of Address3 url parameter.
      java.lang.String getAddressField1URL()
      Gets the name of AddressId url parameter.
      java.lang.String getAddressField2()
      Gets the customizable address field 2.
      java.lang.String getAddressField2URL()
      Gets the name of AddressId url parameter.
      java.lang.String getAddressField3()
      Gets the customizable address field 3.
      java.lang.String getAddressField3URL()
      Gets the name of AddressId url parameter.
      java.lang.String getAddressId()
      Gets the address Id for this address.
      java.lang.String getAddressIdURL()
      Gets the name of AddressId url parameter.
      java.lang.String getAddressType()
      Gets the type of addresses.
      java.lang.String getAddressTypeURL()
      Gets the name of AddressType url parameter.
      java.lang.String getAttribute(java.lang.String astrAttributeName)
      Gets attribute value according to the specified attribute name.
      TypedProperty getAttributes()
      Deprecated. 
      As of release 5.6.1; in order to be more strongly typed, fetch the individual attributes using the appropriate getters on this bean.
      java.lang.String getBestCallingTime()
      Gets the indicator for the best time to call the individual.
      java.lang.String getBestCallingTimeURL()
      Gets the name of BestCallingTime url parameter.
      java.lang.String getBillingCode()
      Gets the code to identify shipping/billing address for BPF.
      java.lang.String getBillingCodeType()
      Gets the code designating the system/method of code structure used for BACODE (for BPF).
      java.lang.String getBillingCodeTypeURL()
      Gets the name of BillingCodeType url parameter.
      java.lang.String getBillingCodeURL()
      Gets the name of BillingCode url parameter.
      java.lang.String getBusinessTitle()
      Gets the business title of the person to which this address applies, eg.
      java.lang.String getBusinessTitleURL()
      Gets the name of BusinessTitle url parameter.
      java.lang.String getCity()
      Gets the city name.
      java.lang.String getCityURL()
      Gets the name of City url parameter.
      CommandContext getCommandContext()
      Returns the command's context within this bean.
      java.lang.String getCountry()
      Gets the country name.
      java.lang.String getCountryDisplayName()
      This method returns the display name for the country described by the getCountry() method, in the language from the command context.
      static java.lang.String getCountryDisplayName(java.lang.Integer anLanguageId, java.lang.String astrCountryAbbreviation)
      Returns the country name for the specified country abbreviation, in the language specified.
      java.lang.String getCountryURL()
      Gets the name of Country url parameter.
      java.lang.String getCreatedTime()
      Gets the date and time when the address was created.
      java.lang.String getCreatedTimestamp()
      Gets the date and time when the address was created.
      java.lang.String getDataBeanKeyAddressId()
      Gets the address Id
      Protectable getDelegate()
      Returns the Protectable object whose access control policies will indirectly control the access control for this object
      java.lang.String getEmail1()
      Gets the e-mail address 1 of the individual.
      java.lang.String getEmail1URL()
      Gets the name of Email1 URL parameter.
      java.lang.String getEmail2()
      Gets the e-mail address 2 of the individual.
      java.lang.String getEmail2URL()
      Gets the name of Email2 URL parameter.
      java.lang.String getFax1()
      Gets the facsimile number 1 of the individual.
      java.lang.String getFax1URL()
      Gets the name of Fax1 URL parameter.
      java.lang.String getFax2()
      Gets the facsimile number 2 of the individual.
      java.lang.String getFax2URL()
      Gets the name of Fax2 URL parameter.
      java.lang.String getFirstName()
      Gets the first name of the individual.
      java.lang.String getFirstNameURL()
      Gets the name of FirstName URL parameter.
      boolean getIsSelfAddress()
      Returns true if the address is a self-address, false otherwise.
      java.lang.String getLastCreate()
      Gets the date and time when the address was created.
      java.lang.String getLastCreateURL()
      Gets the name of FirstName URL parameter.
      java.lang.String getLastName()
      Gets the last name of the individual.
      java.lang.String getLastNameURL()
      Gets the name of LastName URL parameter.
      java.lang.String getMemberId()
      Gets the member Id this address belongs to.
      java.lang.String getMiddleName()
      Gets the middle name of the individual.
      java.lang.String getMiddleNameURL()
      Gets the name of MiddleName URL parameter.
      java.lang.String getMobilePhone1()
      Gets the mobile phone 1 of the individual.
      java.lang.String getMobilePhone1Country()
      Gets the mobile phone 1 country of the individual.
      java.lang.String getMobilePhone1CountryURL()
      Gets the name of MobilePhone1Country URL parameter.
      java.lang.String getMobilePhone1URL()
      Gets the name of MobilePhone1 URL parameter.
      java.lang.String getNickName()
      Gets the nick name of the address.
      java.lang.String getNickNameURL()
      Gets the name of NickName URL parameter.
      java.lang.String getOfficeAddress()
      Gets the desktop delivery or office address associated with a shipping address.
      java.lang.String getOfficeAddressURL()
      Gets the name of OfficeAddress URL parameter.
      java.lang.String getOrganizationName()
      Gets the name of the organization to which this address information applies if this is a business address.
      java.lang.String getOrganizationNameURL()
      Gets the name of OrganizationName URL parameter.
      java.lang.String getOrganizationUnitName()
      Gets the name of the organizational unit to which this contact info applies if this is a business contact.
      java.lang.String getOrganizationUnitNameURL()
      Gets the name of OrganizationUnitName URL parameter.
      java.lang.String getPackageSuppression()
      Gets the Package inserts suppression flag.
      java.lang.String getPackageSuppressionURL()
      Gets the name of PackageSuppression URL parameter.
      java.lang.String getPersonTitle()
      Gets the title of the person to which this address applies.
      java.lang.String getPersonTitleURL()
      Gets the name of PersonTitle URL parameter.
      java.lang.String getPhone1()
      Gets the phone number 1.
      java.lang.String getPhone1Type()
      Gets the type of the phone 1.
      java.lang.String getPhone1TypeURL()
      Gets the name of Phone1Type URL parameter.
      java.lang.String getPhone1URL()
      Gets the name of Phone1 URL parameter.
      java.lang.String getPhone2()
      Gets the phone number 2.
      java.lang.String getPhone2Type()
      Gets the type of the phone 2.
      java.lang.String getPhone2TypeURL()
      Gets the name of Phone2Type URL parameter.
      java.lang.String getPhone2URL()
      Gets the name of Phone2 URL parameter.
      java.lang.String getPrimary()
      Gets an integer indicating whether the address is a primary address.
      java.lang.String getPrimaryURL()
      Gets the name of Primary URL parameter.
      java.lang.String getPublishPhone1()
      Gets an integer indicating whether or not publish the number of phone 1.
      java.lang.String getPublishPhone1URL()
      Gets the name of PublishPhone1 URL parameter.
      java.lang.String getPublishPhone2()
      Gets an integer indicating whether or not publish the number of phone 2.
      java.lang.String getPublishPhone2URL()
      Gets the name of PublishPhone2 URL parameter.
      TypedProperty getRequestProperties()
      Returns the request properties within this bean.
      java.util.List getRetrieveProperties()
      Deprecated. 
      As of release 5.6.1; the list should be null, meaning all properties will be retrieved.
      java.lang.String getState()
      Gets the name of the state, province, or equivalent where the individual resides.
      java.lang.String getStateProvDisplayName()
      This method returns the display name for the state/province described by the getState() method, in the language from the command context.
      static java.lang.String getStateProvDisplayName(java.lang.Integer anLanguageId, java.lang.String astrCountryAbbreviation, java.lang.String astrStateProvAbbreviation)
      Returns the state/province name for the specified state/province abbreviation, country abbreviation, and language specified.
      java.lang.String getStateURL()
      Gets the name of State URL parameter.
      java.lang.String getStatus()
      Gets the temporary or permanent address.
      java.lang.String getStatusURL()
      Gets the name of State URL parameter.
      java.lang.String getStoreDirectory()
      Deprecated. 
      As of release 5.6.1; this is no longer used.
      java.lang.String getStoreIdURL()
      Gets the name of StoreId URL parameter.
      java.lang.String getUrlURL()
      Gets the name of URL parameter: Url.
      java.lang.String getZipCode()
      Gets the zip code or equivalent postal code of the individual's address.
      java.lang.String getZipCodeURL()
      Gets the name of ZipCode URL parameter.
      boolean isSelfAddress()
      Returns true if the address is a self-address, false otherwise.
      void populate()
      Fetches and populates information needed by the bean.
      void setAddressId(java.lang.String astrAddressId)
      Sets the address Id If the address Id is not set, UserRegistrationDataBean will try to find the address according to the NickName and MemberId.
      void setCommandContext(CommandContext aCommandContext)
      Sets the command context to this bean.
      void setDataBeanKeyAddressId(java.lang.String aAddressId)
      Sets the address Id.
      void setMemberId(java.lang.String astrMemberId)
      Sets the member Id If the addressId is not set, The DataBean will try to find the address according to the member Id and nick name.
      void setNickName(java.lang.String astrNickName)
      Sets the Nick Name.
      void setRequestProperties(TypedProperty aRequestProperty)
      Sets the request properties to this bean.
      void setRetrieveProperties(java.util.List propertyNames)
      Deprecated. 
      As of release 5.6.1; all of the properties will be retrieved when this method is not used.
      void setStoreDirectory(java.lang.String astrStoreDirectory)
      Deprecated. 
      As of release 5.6.1; this is no longer used.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COPYRIGHT

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

        public static final java.lang.String CLASSNAME
        The fully qualified name of this class.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AddressDataBean

        public AddressDataBean()
        The default constructor for AddressDataBean.
      • AddressDataBean

        public AddressDataBean(java.lang.String astrAddressId)
        The constructor for AddressDataBean. It will set the addressId for the AddressDataBean.
        Parameters:
        astrAddressId - The AddressId
    • Method Detail

      • findAddress

        public boolean findAddress()
        Returns a boolean value indicating whether the address is found according to addressId or specified nickName . True - The specified address is found False - Can not find the specified address
        Specified by:
        findAddress in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        A boolean value indicating whether the specified address is found
      • getIsSelfAddress

        public boolean getIsSelfAddress()
        Returns true if the address is a self-address, false otherwise.
        Returns:
        true if the address is a self-address, false otherwise
      • isSelfAddress

        public boolean isSelfAddress()
        Returns true if the address is a self-address, false otherwise.
        Returns:
        true if the address is a self-address, false otherwise
      • getAddress1

        public java.lang.String getAddress1()
        Gets the first line of the address.
        Specified by:
        getAddress1 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The first line of the address
      • getAddress1URL

        public java.lang.String getAddress1URL()
        Gets the name of Address1 url parameter.
        Specified by:
        getAddress1URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Address1 url parameter
      • getAddress2

        public java.lang.String getAddress2()
        Gets the second line of the address.
        Specified by:
        getAddress2 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The second line of the address
      • getAddress2URL

        public java.lang.String getAddress2URL()
        Gets the name of Address2 url parameter.
        Specified by:
        getAddress2URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Address2 url parameter
      • getAddress3

        public java.lang.String getAddress3()
        Gets the third line of the address.
        Specified by:
        getAddress3 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The third line of the address
      • getAddress3URL

        public java.lang.String getAddress3URL()
        Gets the name of Address3 url parameter.
        Specified by:
        getAddress3URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Address3 url parameter
      • getAddressField1

        public java.lang.String getAddressField1()
        Gets the name of Address3 url parameter.
        Specified by:
        getAddressField1 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Address3 url parameter
      • getAddressField1URL

        public java.lang.String getAddressField1URL()
        Gets the name of AddressId url parameter.
        Specified by:
        getAddressField1URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of AddressId url parameter
      • getAddressField2

        public java.lang.String getAddressField2()
        Gets the customizable address field 2.
        Specified by:
        getAddressField2 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        astrField2 The customizable address field 2
      • getAddressField2URL

        public java.lang.String getAddressField2URL()
        Gets the name of AddressId url parameter.
        Specified by:
        getAddressField2URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of AddressId url parameter
      • getAddressField3

        public java.lang.String getAddressField3()
        Gets the customizable address field 3.
        Specified by:
        getAddressField3 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        astrField3 The customizable address field 3
      • getAddressField3URL

        public java.lang.String getAddressField3URL()
        Gets the name of AddressId url parameter.
        Specified by:
        getAddressField3URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of AddressId url parameter
      • getAddressId

        public java.lang.String getAddressId()
        Gets the address Id for this address.
        Specified by:
        getAddressId in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The address Id
      • getAddressIdURL

        public java.lang.String getAddressIdURL()
        Gets the name of AddressId url parameter.
        Specified by:
        getAddressIdURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of AddressId url parameter
      • getAddressType

        public java.lang.String getAddressType()
        Gets the type of addresses.
        Specified by:
        getAddressType in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The type of addresses For example:
        • R - residential
        • M - mailing
        • B - billing to
        • S - shipping to
      • getAddressTypeURL

        public java.lang.String getAddressTypeURL()
        Gets the name of AddressType url parameter.
        Specified by:
        getAddressTypeURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of AddressType url parameter
      • getAttribute

        public java.lang.String getAttribute(java.lang.String astrAttributeName)
        Gets attribute value according to the specified attribute name. This method is for IBM Internal use only. For example:
        getAttribute("lastName")
        Parameters:
        astrAttributeName - The name of the attribute
        Returns:
        The value of the attribute
      • getAttributes

        public TypedProperty getAttributes()
        Deprecated. As of release 5.6.1; in order to be more strongly typed, fetch the individual attributes using the appropriate getters on this bean.
        Gets the TypedProperty which contains all attributes of this address. This method is for IBM internal use only.
        Returns:
        The TypedProperty which contains all attributes of this address.
      • getBestCallingTime

        public java.lang.String getBestCallingTime()
        Gets the indicator for the best time to call the individual.
        Specified by:
        getBestCallingTime in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The best time to call For example:
        • D - Daytime
        • E - Evening
      • getBestCallingTimeURL

        public java.lang.String getBestCallingTimeURL()
        Gets the name of BestCallingTime url parameter.
        Specified by:
        getBestCallingTimeURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of BestCallingTime url parameter
      • getBillingCode

        public java.lang.String getBillingCode()
        Gets the code to identify shipping/billing address for BPF.
        Specified by:
        getBillingCode in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The shipping billing code
      • getBillingCodeType

        public java.lang.String getBillingCodeType()
        Gets the code designating the system/method of code structure used for BACODE (for BPF).
        Specified by:
        getBillingCodeType in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The shipping billing code type
      • getBillingCodeTypeURL

        public java.lang.String getBillingCodeTypeURL()
        Gets the name of BillingCodeType url parameter.
        Specified by:
        getBillingCodeTypeURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of BillingCodeType url parameter
      • getBillingCodeURL

        public java.lang.String getBillingCodeURL()
        Gets the name of BillingCode url parameter.
        Specified by:
        getBillingCodeURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of BillingCode url parameter
      • getBusinessTitle

        public java.lang.String getBusinessTitle()
        Gets the business title of the person to which this address applies, eg. Manager, Vice President.
        Specified by:
        getBusinessTitle in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The business title For example:
        • P - President
        • M - Manager
      • getBusinessTitleURL

        public java.lang.String getBusinessTitleURL()
        Gets the name of BusinessTitle url parameter.
        Specified by:
        getBusinessTitleURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of BusinessTitle url parameter
      • getCity

        public java.lang.String getCity()
        Gets the city name.
        Specified by:
        getCity in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The city name
      • getCityURL

        public java.lang.String getCityURL()
        Gets the name of City url parameter.
        Specified by:
        getCityURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of City url parameter
      • getCommandContext

        public CommandContext getCommandContext()
        Returns the command's context within this bean.
        Specified by:
        getCommandContext in interface SmartDataBean
        Returns:
        com.ibm.commerce.command.CommandContext
      • getCountry

        public java.lang.String getCountry()
        Gets the country name.
        Specified by:
        getCountry in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The country name
      • getCountryDisplayName

        public java.lang.String getCountryDisplayName()
        This method returns the display name for the country described by the getCountry() method, in the language from the command context. The method assumes that the value in the COUNTRY field of the address record is a foreign key to the COUNTRY.COUNTRYABBR field. If the COUNTRY record cannot be resolved for the abbreviation and language specified, then the value from the COUNTRY field will be returned directly.
        Returns:
        The display name for the country referenced by the COUNTRY field of the address record.
      • getCountryDisplayName

        public static java.lang.String getCountryDisplayName(java.lang.Integer anLanguageId,
                                                             java.lang.String astrCountryAbbreviation)
        Returns the country name for the specified country abbreviation, in the language specified. If the country name cannot be resolved for the specified inputs, then null will be returned.
        Parameters:
        anLanguageId - The language Id.
        astrCountryAbbreviation - The country abbreviation.
        Returns:
        The display name for the country; null if the country name cannot be resolved.
      • getCountryURL

        public java.lang.String getCountryURL()
        Gets the name of Country url parameter.
        Specified by:
        getCountryURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Country url parameter
      • getCreatedTime

        public java.lang.String getCreatedTime()
        Gets the date and time when the address was created.
        Specified by:
        getCreatedTime in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The date and time when the address was created
      • getCreatedTimestamp

        public java.lang.String getCreatedTimestamp()
        Gets the date and time when the address was created.
        Specified by:
        getCreatedTimestamp in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The date and time when the address was created
      • getDataBeanKeyAddressId

        public java.lang.String getDataBeanKeyAddressId()
        Gets the address Id
        Specified by:
        getDataBeanKeyAddressId in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The address Id.
      • getDelegate

        public Protectable getDelegate()
                                throws java.lang.Exception
        Returns the Protectable object whose access control policies will indirectly control the access control for this object
        Specified by:
        getDelegate in interface Delegator
        Returns:
        The Protectable object whose access control policies will indirectly control the access control for this object
        Throws:
        java.lang.Exception
      • getEmail1

        public java.lang.String getEmail1()
        Gets the e-mail address 1 of the individual.
        Specified by:
        getEmail1 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The e-mail address 1 of the individual
      • getEmail1URL

        public java.lang.String getEmail1URL()
        Gets the name of Email1 URL parameter.
        Specified by:
        getEmail1URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Email1 URL parameter
      • getEmail2

        public java.lang.String getEmail2()
        Gets the e-mail address 2 of the individual.
        Specified by:
        getEmail2 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The e-mail address 2 of the individual
      • getEmail2URL

        public java.lang.String getEmail2URL()
        Gets the name of Email2 URL parameter.
        Specified by:
        getEmail2URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Email2 URL parameter
      • getFax1

        public java.lang.String getFax1()
        Gets the facsimile number 1 of the individual.
        Specified by:
        getFax1 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The facsimile number 1
      • getFax1URL

        public java.lang.String getFax1URL()
        Gets the name of Fax1 URL parameter.
        Specified by:
        getFax1URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Fax1 URL parameter
      • getFax2

        public java.lang.String getFax2()
        Gets the facsimile number 2 of the individual.
        Specified by:
        getFax2 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The facsimile number 2
      • getFax2URL

        public java.lang.String getFax2URL()
        Gets the name of Fax2 URL parameter.
        Specified by:
        getFax2URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Fax2 URL parameter
      • getMobilePhone1

        public java.lang.String getMobilePhone1()
        Gets the mobile phone 1 of the individual.
        Specified by:
        getMobilePhone1 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The mobile phone 1
      • getMobilePhone1URL

        public java.lang.String getMobilePhone1URL()
        Gets the name of MobilePhone1 URL parameter.
        Specified by:
        getMobilePhone1URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of MobilePhone1 URL parameter
      • getMobilePhone1Country

        public java.lang.String getMobilePhone1Country()
        Gets the mobile phone 1 country of the individual.
        Specified by:
        getMobilePhone1Country in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The mobile phone 1 country
      • getMobilePhone1CountryURL

        public java.lang.String getMobilePhone1CountryURL()
        Gets the name of MobilePhone1Country URL parameter.
        Specified by:
        getMobilePhone1CountryURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of MobilePhone1Country URL parameter
      • getFirstName

        public java.lang.String getFirstName()
        Gets the first name of the individual.
        Specified by:
        getFirstName in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The first name
      • getFirstNameURL

        public java.lang.String getFirstNameURL()
        Gets the name of FirstName URL parameter.
        Specified by:
        getFirstNameURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of FirstName URL parameter
      • getLastCreate

        public java.lang.String getLastCreate()
        Gets the date and time when the address was created.
        Specified by:
        getLastCreate in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The date and time when the address was created
      • getLastCreateURL

        public java.lang.String getLastCreateURL()
        Gets the name of FirstName URL parameter.
        Specified by:
        getLastCreateURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of FirstName URL parameter
      • getLastName

        public java.lang.String getLastName()
        Gets the last name of the individual.
        Specified by:
        getLastName in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The last name
      • getLastNameURL

        public java.lang.String getLastNameURL()
        Gets the name of LastName URL parameter.
        Specified by:
        getLastNameURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of LastName URL parameter
      • getMemberId

        public java.lang.String getMemberId()
        Gets the member Id this address belongs to.
        Specified by:
        getMemberId in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The member Id this address belongs to
      • getMiddleName

        public java.lang.String getMiddleName()
        Gets the middle name of the individual.
        Specified by:
        getMiddleName in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The middle name
      • getMiddleNameURL

        public java.lang.String getMiddleNameURL()
        Gets the name of MiddleName URL parameter.
        Specified by:
        getMiddleNameURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of MiddleName URL parameter
      • getNickName

        public java.lang.String getNickName()
        Gets the nick name of the address.
        Specified by:
        getNickName in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The nick name of the address
      • getNickNameURL

        public java.lang.String getNickNameURL()
        Gets the name of NickName URL parameter.
        Specified by:
        getNickNameURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of NickName URL parameter
      • getOfficeAddress

        public java.lang.String getOfficeAddress()
        Gets the desktop delivery or office address associated with a shipping address. Note this is an internal address, such as office number and so forth not a full-blown address with street number, city, province/state, country, postal code, and so forth.
        Specified by:
        getOfficeAddress in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The office address.
      • getOfficeAddressURL

        public java.lang.String getOfficeAddressURL()
        Gets the name of OfficeAddress URL parameter.
        Specified by:
        getOfficeAddressURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of OfficeAddress URL parameter
      • getOrganizationName

        public java.lang.String getOrganizationName()
        Gets the name of the organization to which this address information applies if this is a business address.
        Specified by:
        getOrganizationName in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of the organization
      • getOrganizationNameURL

        public java.lang.String getOrganizationNameURL()
        Gets the name of OrganizationName URL parameter.
        Specified by:
        getOrganizationNameURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of OrganizationName URL parameter
      • getOrganizationUnitName

        public java.lang.String getOrganizationUnitName()
        Gets the name of the organizational unit to which this contact info applies if this is a business contact.
        Specified by:
        getOrganizationUnitName in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of the organizational unit.
      • getOrganizationUnitNameURL

        public java.lang.String getOrganizationUnitNameURL()
        Gets the name of OrganizationUnitName URL parameter.
        Specified by:
        getOrganizationUnitNameURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of OrganizationUnitName URL parameter
      • getPackageSuppression

        public java.lang.String getPackageSuppression()
        Gets the Package inserts suppression flag.
        Specified by:
        getPackageSuppression in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The package suppression flag
        • 1 - include
        • 0 - do not include
      • getPackageSuppressionURL

        public java.lang.String getPackageSuppressionURL()
        Gets the name of PackageSuppression URL parameter.
        Specified by:
        getPackageSuppressionURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of PackageSuppression URL parameter
      • getPersonTitle

        public java.lang.String getPersonTitle()
        Gets the title of the person to which this address applies.
        Specified by:
        getPersonTitle in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The person title For example:
        • N - Not provided (default)
        • Mr - Mr.
        • Mrs - Mrs.
        • Ms - Ms.
        • Dr - Dr.
        • Prof- Prof.
      • getPersonTitleURL

        public java.lang.String getPersonTitleURL()
        Gets the name of PersonTitle URL parameter.
        Specified by:
        getPersonTitleURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of PersonTitle URL parameter
      • getPhone1

        public java.lang.String getPhone1()
        Gets the phone number 1.
        Specified by:
        getPhone1 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        the phone number 1
      • getPhone1Type

        public java.lang.String getPhone1Type()
        Gets the type of the phone 1.
        Specified by:
        getPhone1Type in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The type of phone1 For Example:
        • PHN - standard phone
        • TTY - teletypewriter for people who have a hearing impairment
      • getPhone1TypeURL

        public java.lang.String getPhone1TypeURL()
        Gets the name of Phone1Type URL parameter.
        Specified by:
        getPhone1TypeURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Phone1Type URL parameter
      • getPhone1URL

        public java.lang.String getPhone1URL()
        Gets the name of Phone1 URL parameter.
        Specified by:
        getPhone1URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Phone1 URL parameter
      • getPhone2

        public java.lang.String getPhone2()
        Gets the phone number 2.
        Specified by:
        getPhone2 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        the phone number 2
      • getPhone2Type

        public java.lang.String getPhone2Type()
        Gets the type of the phone 2.
        Specified by:
        getPhone2Type in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The type of phone2 For Example:
        • PHN - standard phone
        • TTY - teletypewriter for people who have a hearing impairment
      • getPhone2TypeURL

        public java.lang.String getPhone2TypeURL()
        Gets the name of Phone2Type URL parameter.
        Specified by:
        getPhone2TypeURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Phone2Type URL parameter
      • getPhone2URL

        public java.lang.String getPhone2URL()
        Gets the name of Phone2 URL parameter.
        Specified by:
        getPhone2URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Phone2 URL parameter
      • getPrimary

        public java.lang.String getPrimary()
        Gets an integer indicating whether the address is a primary address. This allows multiple addresses for each address type. (eg. Multiple billing addresses, multiple shipping addresses) and one of them to be designated as the 'primary billing address', 'primary shipping address', and so forth. Each address type can have one or none primary address.
        Specified by:
        getPrimary in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        An integer indicating whether the address is a primary address
        • 1 - primary (or default) address
        • 0 - not primary address
      • getPrimaryURL

        public java.lang.String getPrimaryURL()
        Gets the name of Primary URL parameter.
        Specified by:
        getPrimaryURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of Primary URL parameter
      • getPublishPhone1

        public java.lang.String getPublishPhone1()
        Gets an integer indicating whether or not publish the number of phone 1.
        Specified by:
        getPublishPhone1 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        An integer indicating whether or not publish the number of phone 1
        • 1 - publish the number of phone 1
        • 0 - not publish the number of phone 1
      • getPublishPhone1URL

        public java.lang.String getPublishPhone1URL()
        Gets the name of PublishPhone1 URL parameter.
        Specified by:
        getPublishPhone1URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of PublishPhone1 URL parameter
      • getPublishPhone2

        public java.lang.String getPublishPhone2()
        Gets an integer indicating whether or not publish the number of phone 2.
        Specified by:
        getPublishPhone2 in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        An integer indicating whether or not publish the number of phone 2
        • 1 - publish the number of phone 2
        • 0 - not publish the number of phone 2
      • getPublishPhone2URL

        public java.lang.String getPublishPhone2URL()
        Gets the name of PublishPhone2 URL parameter.
        Specified by:
        getPublishPhone2URL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of PublishPhone2 URL parameter
      • getRequestProperties

        public TypedProperty getRequestProperties()
        Returns the request properties within this bean.
        Specified by:
        getRequestProperties in interface InputDataBean
        Returns:
        com.ibm.commerce.datatype.TypedProperty
      • getState

        public java.lang.String getState()
        Gets the name of the state, province, or equivalent where the individual resides.
        Specified by:
        getState in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of the state
      • getStateURL

        public java.lang.String getStateURL()
        Gets the name of State URL parameter.
        Specified by:
        getStateURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of State URL parameter
      • getStateProvDisplayName

        public java.lang.String getStateProvDisplayName()
        This method returns the display name for the state/province described by the getState() method, in the language from the command context. The method assumes that the value in the STATE field of the address record is a foreign key to the STATEPROV.STATEPROVABBR field. If the STATEPROV record cannot be resolved for the abbreviation and language specified, then the value from the STATE field will be returned directly.
        Returns:
        The display name for the state/province referenced by the STATE field of the address record.
      • getStateProvDisplayName

        public static java.lang.String getStateProvDisplayName(java.lang.Integer anLanguageId,
                                                               java.lang.String astrCountryAbbreviation,
                                                               java.lang.String astrStateProvAbbreviation)
        Returns the state/province name for the specified state/province abbreviation, country abbreviation, and language specified. If the state/province name cannot be resolved for the specified inputs, then null will be returned.
        Parameters:
        anLanguageId - The language Id.
        astrCountryAbbreviation - The country abbreviation.
        astrStateProvAbbreviation - The state/province abbreviation.
        Returns:
        The display name for the state/province; null if it cannot be resolved.
      • getStatus

        public java.lang.String getStatus()
        Gets the temporary or permanent address. 'Permanent' really means 'current' address; 'Temporary' really means 'historical' address. Each time an address is updated, a new address will be created and the old address will become a temporary address.
        • P - permanent address
        • T - temporary address
        Specified by:
        getStatus in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The status of the address
      • getStatusURL

        public java.lang.String getStatusURL()
        Gets the name of State URL parameter.
        Returns:
        The name of State URL parameter
      • getStoreDirectory

        public java.lang.String getStoreDirectory()
        Deprecated. As of release 5.6.1; this is no longer used.
        Gets the name of the store directory, which was used in getUserRegistrationProperties for the path to the property file.
        Specified by:
        getStoreDirectory in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of the store directory
      • getStoreIdURL

        public java.lang.String getStoreIdURL()
        Gets the name of StoreId URL parameter.
        Specified by:
        getStoreIdURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of StoreId URL parameter
      • getUrlURL

        public java.lang.String getUrlURL()
        Gets the name of URL parameter: Url.
        Specified by:
        getUrlURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of URL parameter: Url.
      • getZipCode

        public java.lang.String getZipCode()
        Gets the zip code or equivalent postal code of the individual's address.
        Specified by:
        getZipCode in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The zip code
      • getZipCodeURL

        public java.lang.String getZipCodeURL()
        Gets the name of ZipCode URL parameter.
        Specified by:
        getZipCodeURL in interface com.ibm.commerce.user.beans.AddressSmartDataBean
        Returns:
        The name of ZipCode URL parameter
      • populate

        public void populate()
                      throws java.lang.Exception
        Fetches and populates information needed by the bean.
        Specified by:
        populate in interface SmartDataBean
        Throws:
        java.lang.Exception - Any exception thrown during populating.
      • setAddressId

        public void setAddressId(java.lang.String astrAddressId)
        Sets the address Id If the address Id is not set, UserRegistrationDataBean will try to find the address according to the NickName and MemberId.
        Specified by:
        setAddressId in interface com.ibm.commerce.user.beans.AddressInputDataBean
        Parameters:
        astrAddressId - The address Id
      • setCommandContext

        public void setCommandContext(CommandContext aCommandContext)
        Sets the command context to this bean.
        Specified by:
        setCommandContext in interface SmartDataBean
        Parameters:
        aCommandContext - com.ibm.commerce.command.CommandContext
      • setDataBeanKeyAddressId

        public void setDataBeanKeyAddressId(java.lang.String aAddressId)
        Sets the address Id.
        Specified by:
        setDataBeanKeyAddressId in interface com.ibm.commerce.user.beans.AddressInputDataBean
        Parameters:
        aAddressId - The address Id
      • setMemberId

        public void setMemberId(java.lang.String astrMemberId)
        Sets the member Id If the addressId is not set, The DataBean will try to find the address according to the member Id and nick name.
        Specified by:
        setMemberId in interface com.ibm.commerce.user.beans.AddressInputDataBean
        Parameters:
        astrMemberId - The MemberId
      • setNickName

        public void setNickName(java.lang.String astrNickName)
        Sets the Nick Name. If the AddressId is not set, The DataBean will try to find the address according to the Nick Name and MemberId.
        Specified by:
        setNickName in interface com.ibm.commerce.user.beans.AddressInputDataBean
        Parameters:
        astrNickName - The Nickname
      • setRequestProperties

        public void setRequestProperties(TypedProperty aRequestProperty)
        Sets the request properties to this bean.
        Specified by:
        setRequestProperties in interface InputDataBean
        Parameters:
        aRequestProperty - com.ibm.commerce.datatype.TypedProperty
      • setStoreDirectory

        public void setStoreDirectory(java.lang.String astrStoreDirectory)
        Deprecated. As of release 5.6.1; this is no longer used.
        Sets the name of store directory, which is used as the path to find the property file in getAddressProperties method.
        Specified by:
        setStoreDirectory in interface com.ibm.commerce.user.beans.AddressInputDataBean
        Parameters:
        astrStoreDirectory - The name of store directory
      • setRetrieveProperties

        public void setRetrieveProperties(java.util.List propertyNames)
        Deprecated. As of release 5.6.1; all of the properties will be retrieved when this method is not used.
        Sets the property names to retrieve. If not set, the data bean will retrieve all properties of this address. If set, the data bean will only retrieve the properties specified.
        Parameters:
        propertyNames - The name of the properties need to retrieve.
      • getRetrieveProperties

        public java.util.List getRetrieveProperties()
        Deprecated. As of release 5.6.1; the list should be null, meaning all properties will be retrieved.
        Gets a list of property names to retrieve. If the list is null, the data bean will retrieve all properties of this address. If the list is not null, the data bean will only retrieve the properties specified.
        Returns:
        The list of property names to retrieve.