com.ibm.commerce.common.beans

Class StoreAddressDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.common.objects.StoreAddressAccessBean

com.ibm.commerce.common.beansrc.StoreAddressDataBeanBase

com.ibm.commerce.common.beans.StoreAddressDataBean

All Implemented Interfaces:

com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, StoreAddressInputDataBean, StoreAddressSmartDataBean, com.ibm.commerce.security.Delegator, java.io.Serializable

public class StoreAddressDataBean
extends StoreAddressDataBeanBase
implements StoreAddressInputDataBean, StoreAddressSmartDataBean

This data bean represents information from the STADDRESS table. This table contains the store's address information. It can either be store's contact or physical location address.

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 statement

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
StoreAddressDataBean()

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.command.CommandContext	getCommandContext() This method gets the command context set within this bean.
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) This method returns the country name for the specified country abbreviation, in the language specified.
java.lang.String	getDataBeanKeyStoreAddressId() This method gets the store address id.
com.ibm.commerce.datatype.TypedProperty	getRequestProperties() This method gets the request property set within this bean.
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) This method returns the state/province name for the specified state/province abbreviation, country abbreviation, and language specified.
void	populate() This method loads the data for this bean.
void	setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext) This method sets the command context within this bean.
void	setDataBeanKeyStoreAddressId(java.lang.String aStoreAddressId) This method sets the store address id (this is the only mandatory parameter that must be set before activating this bean.
void	setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperty) This method sets the request property within this bean.

Methods inherited from class com.ibm.commerce.common.beansrc.StoreAddressDataBeanBase

getDelegate

Methods inherited from class com.ibm.commerce.common.objects.StoreAddressAccessBean

findByMemberIdAndNickName, getAddress1, getAddress2, getAddress3, getAddressField1, getAddressField2, getAddressField3, getBusinessTitle, getCity, getCountry, getEmail1, getEmail2, getEntity, getFax1, getFax2, getField1, getField2, getFirstName, getLastName, getMemberId, getMemberIdInEntityType, getMiddleName, getNickName, getPersonTitle, getPhone1, getPhone2, getShippingGeoCode, getState, getStoreAddressId, getStoreAddressIdInEntityType, getTaxGeoCode, getURL, getZipCode, instantiateEntity, setAddress1, setAddress2, setAddress3, setAddressField1, setAddressField2, setAddressField3, setBusinessTitle, setCity, setCountry, setEmail1, setEmail2, setFax1, setFax2, setField1, setField2, setFirstName, setInitKey_storeAddressId, setInitKey_storeAddressId, setLastName, setMemberId, setMemberId, setMiddleName, setNickName, setPersonTitle, setPhone1, setPhone2, setShippingGeoCode, setState, setTaxGeoCode, setURL, setZipCode

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, remove, setUseDataCache, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

The fully qualified name of this class.

See Also:

Constant Field Values

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright statement

See Also:

Constant Field Values

Constructor Detail

StoreAddressDataBean

public StoreAddressDataBean()

Method Detail

getCommandContext

public com.ibm.commerce.command.CommandContext getCommandContext()

This method gets the command context set within this bean.

Specified by:

getCommandContext in interface com.ibm.commerce.beans.SmartDataBean

Returns:

The command context set within this bean.

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)

This method 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 name to display for this country; null if this name cannot be resolved.

getDataBeanKeyStoreAddressId

public java.lang.String getDataBeanKeyStoreAddressId()

This method gets the store address id.

Specified by:

getDataBeanKeyStoreAddressId in interface StoreAddressSmartDataBean

Returns:

The store address id.

getRequestProperties

public com.ibm.commerce.datatype.TypedProperty getRequestProperties()

This method gets the request property set within this bean.

Specified by:

getRequestProperties in interface com.ibm.commerce.beans.InputDataBean

Returns:

The request property set within this bean.

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)

This method 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 name to display for this state or province; null if this name cannot be resolved.

populate

public void populate()

This method loads the data for this bean. Retrieve the information from the STADDRESS table. Loads data into the data bean when the DataBeanManager.activate() executes.

Specified by:

populate in interface com.ibm.commerce.beans.SmartDataBean

Throws:

java.lang.Exception - The java.lang.Exception exception.

setCommandContext

public void setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext)

This method sets the command context within this bean.

Specified by:

setCommandContext in interface com.ibm.commerce.beans.SmartDataBean

Parameters:

aCommandContext - The command context to set within this bean.

setDataBeanKeyStoreAddressId

public void setDataBeanKeyStoreAddressId(java.lang.String aStoreAddressId)

This method sets the store address id (this is the only mandatory parameter that must be set before activating this bean.

Specified by:

setDataBeanKeyStoreAddressId in interface StoreAddressInputDataBean

Parameters:

aStoreAddressId - The store address id.

setRequestProperties

public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperty)

This method sets the request property within this bean.

Specified by:

setRequestProperties in interface com.ibm.commerce.beans.InputDataBean

Parameters:

aRequestProperty - The request property to set within this bean.