java.lang.Object | +--com.ibm.commerce.user.beans.AddressDataBean
The bean representing a address.
The following code can be used to create and active a AddressDataBean:
AddressDataBean bnAddress = new AddressDataBean(); com.ibm.commerce.beans.DataBeanManager.activate(bnAddress, request);The addressDataBean will try to get the addressId and nickName parameter from request. If addressId is not null, it will find this address using the addressId. If addressId is null, it will find this address using the nickName. Users can also direclty call setAddressId(String) and setNickName(String) methods to set addressId and NickName directly, overwriting the values get from request.
AddressDataBean bnAddress = new AddressDataBean(); bnAddress.setAddressId(istrAddressId); com.ibm.commerce.beans.DataBeanManager.activate(bnAddress, request);If the specified address is found, the findAddress() method will return true, otherwise return false.
Field Summary | |
---|---|
static java.lang.String |
CLASSNAME The full qualified name of this class. |
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
protected
CommandContext |
iCommandContext The command context within this bean. |
protected
java.lang.String |
iDataBeanKeyAddressId The key of this data bean. |
protected
AddressManageBean |
imbAddress The address manage bean. |
protected
TypedProperty |
iRequestProperties The request properties within this bean. |
protected
java.lang.String |
istrMemberId The member id of the owner of this address |
protected
java.lang.String |
istrNickName The nick name of this address |
protected
java.lang.String |
istrStoreDirectory The store directory. |
Constructor Summary | |
---|---|
AddressDataBean() The default constructor for AddressDataBean. | |
AddressDataBean(java.lang.String astrAddressId) The constructor for AddressDataBean. |
Method Summary | |
---|---|
boolean |
findAddress() Returns a boolean value indicating whether the address is found according to addressId or nickName specified. |
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 specifid attribute name. |
TypedProperty |
getAttributes() Gets the TypedProperty which contains all attributes of this address. |
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 |
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 |
com.ibm.commerce.security.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 or URL address 1 of the individual. |
java.lang.String |
getEmail1URL() Gets the name of Email1 URL parameter. |
java.lang.String |
getEmail2() Gets the e-mail or URL 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. |
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 |
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 informatoin 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 a 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 a integer indicating whether or not publish phone 1 number. |
java.lang.String |
getPublishPhone1URL() Gets the name of PublishPhone1 URL parameter. |
java.lang.String |
getPublishPhone2() Gets a integer indicating whether or not publish phone 2 number. |
java.lang.String |
getPublishPhone2URL() Gets the name of PublishPhone2 URL parameter. |
TypedProperty |
getRequestProperties() Returns the request properties within this bean. |
java.util.List |
getRetrieveProperties() Gets a list of property names need to retrieve. |
java.lang.String |
getState() Gets the name of the state, province, or equivalent where the individual resides. |
java.lang.String |
getStateURL() Gets the name of State URL parameter. |
java.lang.String |
getStatus() Gets the temporary or permanent address, 'Permanent' really means 'current' address, 'Temporary' really means 'historical' address. |
java.lang.String |
getStatusURL() Gets the name of State URL parameter. |
java.lang.String |
getStoreDirectory() Gets the name of the store directory, which is used in getUserRegistrationProperties for the path to the property file. |
java.lang.String |
getStoreIdURL() Gets the name of StoreId URL parameter. |
java.lang.String |
getUrlURL() Gets the name of Url URL parameter. |
java.lang.String |
getZipCode() Gets the zip code or equivalent postal code of the individual's adddres. |
java.lang.String |
getZipCodeURL() Gets the name of ZipCode URL parameter. |
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 MemberId If the AddressId is not set, The DataBean will try to find the address according to the MemberId 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) Sets the property names need to retrieve. |
void |
setStoreDirectory(java.lang.String astrStoreDirectory) Sets the name of store directory, which is used as the path to the find the property file in getAddressProperties method. |
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
public static final java.lang.String CLASSNAME
protected java.lang.String iDataBeanKeyAddressId
protected java.lang.String istrNickName
protected java.lang.String istrMemberId
protected CommandContext iCommandContext
protected TypedProperty iRequestProperties
protected AddressManageBean imbAddress
protected java.lang.String istrStoreDirectory
Constructor Detail |
---|
public AddressDataBean()
public AddressDataBean(java.lang.String astrAddressId)
astrAddressId
- The AddressIdMethod Detail |
---|
public boolean findAddress()
public java.lang.String getAddress1()
public java.lang.String getAddress1URL()
public java.lang.String getAddress2()
public java.lang.String getAddress2URL()
public java.lang.String getAddress3()
public java.lang.String getAddress3URL()
public java.lang.String getAddressField1()
public java.lang.String getAddressField1URL()
public java.lang.String getAddressField2()
public java.lang.String getAddressField2URL()
public java.lang.String getAddressField3()
public java.lang.String getAddressField3URL()
public java.lang.String getAddressId()
public java.lang.String getAddressIdURL()
public java.lang.String getAddressType()
public java.lang.String getAddressTypeURL()
public java.lang.String getAttribute(java.lang.String astrAttributeName)
getAttribute("lastName") - returns the last name. This method is same as getLastName().
public TypedProperty getAttributes()
public java.lang.String getBestCallingTime()
public java.lang.String getBestCallingTimeURL()
public java.lang.String getBillingCode()
public java.lang.String getBillingCodeType()
public java.lang.String getBillingCodeTypeURL()
public java.lang.String getBillingCodeURL()
public java.lang.String getBusinessTitle()
public java.lang.String getBusinessTitleURL()
public java.lang.String getCity()
public java.lang.String getCityURL()
public CommandContext getCommandContext()
public java.lang.String getCountry()
public java.lang.String getCountryURL()
public java.lang.String getCreatedTime()
public java.lang.String getCreatedTimestamp()
public java.lang.String getDataBeanKeyAddressId()
public com.ibm.commerce.security.Protectable getDelegate() throws java.lang.Exception
java.lang.Exception
public java.lang.String getEmail1()
public java.lang.String getEmail1URL()
public java.lang.String getEmail2()
public java.lang.String getEmail2URL()
public java.lang.String getFax1()
public java.lang.String getFax1URL()
public java.lang.String getFax2()
public java.lang.String getFax2URL()
public java.lang.String getFirstName()
public java.lang.String getFirstNameURL()
public java.lang.String getLastCreate()
public java.lang.String getLastCreateURL()
public java.lang.String getLastName()
public java.lang.String getLastNameURL()
public java.lang.String getMemberId()
public java.lang.String getMiddleName()
public java.lang.String getMiddleNameURL()
public java.lang.String getNickName()
public java.lang.String getNickNameURL()
public java.lang.String getOfficeAddress()
public java.lang.String getOfficeAddressURL()
public java.lang.String getOrganizationName()
public java.lang.String getOrganizationNameURL()
public java.lang.String getOrganizationUnitName()
public java.lang.String getOrganizationUnitNameURL()
public java.lang.String getPackageSuppression()
public java.lang.String getPackageSuppressionURL()
public java.lang.String getPersonTitle()
public java.lang.String getPersonTitleURL()
public java.lang.String getPhone1()
public java.lang.String getPhone1Type()
public java.lang.String getPhone1TypeURL()
public java.lang.String getPhone1URL()
public java.lang.String getPhone2()
public java.lang.String getPhone2Type()
public java.lang.String getPhone2TypeURL()
public java.lang.String getPhone2URL()
public java.lang.String getPrimary()
public java.lang.String getPrimaryURL()
public java.lang.String getPublishPhone1()
public java.lang.String getPublishPhone1URL()
public java.lang.String getPublishPhone2()
public java.lang.String getPublishPhone2URL()
public TypedProperty getRequestProperties()
public java.lang.String getState()
public java.lang.String getStateURL()
public java.lang.String getStatus()
public java.lang.String getStatusURL()
public java.lang.String getStoreDirectory()
public java.lang.String getStoreIdURL()
public java.lang.String getUrlURL()
public java.lang.String getZipCode()
public java.lang.String getZipCodeURL()
public void populate() throws java.lang.Exception
java.lang.Exception
- Any exception thrown during
populating.public void setAddressId(java.lang.String astrAddressId)
astrAddressId
- The address Idpublic void setCommandContext(CommandContext acommandContext)
public void setDataBeanKeyAddressId(java.lang.String aAddressId)
aAddressId
- The address Idpublic void setMemberId(java.lang.String astrMemberId)
astrMemberId
- The MemberIdpublic void setNickName(java.lang.String astrNickName)
astrNickName
- The Nicknamepublic void setRequestProperties(TypedProperty aRequestProperty)
public void setStoreDirectory(java.lang.String astrStoreDirectory)
astrStoreDirectory
- The name of store
directorypublic void setRetrieveProperties(java.util.List propertyNames)
propertyNames
- The name of the properties need to
retrieve.public java.util.List getRetrieveProperties()