de.hybris.platform.jalo.user

Class Address

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.jalo.user.GeneratedAddress

de.hybris.platform.jalo.user.Address

All Implemented Interfaces:

Serializable, Comparable

public class Address
extends GeneratedAddress

The hybris Platform address item.

Addresses are owned by users and used for addressing orders and carts. All fields of a address are stored as properties. This way addresses are easily extendable. All default field names are defined as constants.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Address.GENDER_ENUM Deprecated.

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALL_PROPERTY_FIELDS Deprecated. Use ComposedType.getAttributeDescriptors()
static String	CUSTOM1 Deprecated. Attribute does not longer exists.
static String	CUSTOM2 Deprecated. Attribute does not longer exists.
static String	DATHEOFBIRTH Deprecated.
static String	FLOOR Deprecated. Attribute does not longer exists.
static String	GENDER_ENUM_TYPE Deprecated.
static String	PLANET Deprecated. Attribute does not longer exists.
static String	STREETSECTION Deprecated. Attribute does not longer exists.
static String	STREETTYPE Deprecated. Attribute does not longer exists.
static String	USER Constant identifier for owner attribute of Address type.

Fields inherited from class de.hybris.platform.jalo.user.GeneratedAddress

APPARTMENT, BUILDING, CELLPHONE, COMPANY, COUNTRY, DATEOFBIRTH, DEFAULT_INITIAL_ATTRIBUTES, DEPARTMENT, DISTRICT, DUPLICATE, EMAIL, FAX, FIRSTNAME, GENDER, LASTNAME, MIDDLENAME, MIDDLENAME2, ORIGINAL, OWNERHANDLER, PHONE1, PHONE2, POBOX, POSTALCODE, REGION, STREETNAME, STREETNUMBER, TITLE, TOWN

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
Address()

Method Summary

Modifier and Type	Method and Description
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
EnumerationValue	getGender(String key) Deprecated. use GeneratedAddress.getGender(), the given key is obsolete
User	getUser() Returns the assigned User of this Address.
Boolean	isDuplicate(SessionContext ctx) Generated method - Getter of the Address.duplicate attribute.
void	remove() Removes this item.
void	setGender(String key, EnumerationValue value) Deprecated. use GeneratedAddress.setGender(EnumerationValue), the given key is obsolete
void	setOriginal(Address value) Generated method - Setter of the Address.original attribute.
void	setOriginal(SessionContext ctx, Address value) Generated method - Setter of the Address.original attribute.
void	setUser(User user) Assigns a new User to this Address.

Methods inherited from class de.hybris.platform.jalo.user.GeneratedAddress

getAppartment, getAppartment, getBuilding, getBuilding, getCellphone, getCellphone, getCompany, getCompany, getCountry, getCountry, getDateOfBirth, getDateOfBirth, getDefaultAttributeModes, getDepartment, getDepartment, getDistrict, getDistrict, getEmail, getEmail, getFax, getFax, getFirstname, getFirstname, getGender, getGender, getLastname, getLastname, getMiddlename, getMiddlename, getMiddlename2, getMiddlename2, getOriginal, getOriginal, getPhone1, getPhone1, getPhone2, getPhone2, getPobox, getPobox, getPostalcode, getPostalcode, getRegion, getRegion, getStreetname, getStreetname, getStreetnumber, getStreetnumber, getTitle, getTitle, getTown, getTown, isDuplicate, isDuplicateAsPrimitive, isDuplicateAsPrimitive, setAppartment, setAppartment, setBuilding, setBuilding, setCellphone, setCellphone, setCompany, setCompany, setCountry, setCountry, setDateOfBirth, setDateOfBirth, setDepartment, setDepartment, setDistrict, setDistrict, setDuplicate, setDuplicate, setDuplicate, setDuplicate, setEmail, setEmail, setFax, setFax, setFirstname, setFirstname, setGender, setGender, setLastname, setLastname, setMiddlename, setMiddlename, setMiddlename2, setMiddlename2, setPhone1, setPhone1, setPhone2, setPhone2, setPobox, setPobox, setPostalcode, setPostalcode, setRegion, setRegion, setStreetname, setStreetname, setStreetnumber, setStreetnumber, setTitle, setTitle, setTown, setTown

Methods inherited from class de.hybris.platform.jalo.GenericItem

getInitialProperties, getNonInitialAttributes

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STREETTYPE

@Deprecated
public static final String STREETTYPE

Deprecated. Attribute does not longer exists.

See Also:

Constant Field Values

FLOOR

@Deprecated
public static final String FLOOR

Deprecated. Attribute does not longer exists.

See Also:

Constant Field Values

PLANET

@Deprecated
public static final String PLANET

Deprecated. Attribute does not longer exists.

See Also:

Constant Field Values

STREETSECTION

@Deprecated
public static final String STREETSECTION

Deprecated. Attribute does not longer exists.

See Also:

Constant Field Values

CUSTOM1

@Deprecated
public static final String CUSTOM1

Deprecated. Attribute does not longer exists.

See Also:

Constant Field Values

CUSTOM2

@Deprecated
public static final String CUSTOM2

Deprecated. Attribute does not longer exists.

See Also:

Constant Field Values

USER

public static final String USER

Constant identifier for owner attribute of Address type.

DATHEOFBIRTH

@Deprecated
public static final String DATHEOFBIRTH

Deprecated.

See Also:

Constant Field Values

ALL_PROPERTY_FIELDS

@Deprecated
public static final String[] ALL_PROPERTY_FIELDS

Deprecated. Use ComposedType.getAttributeDescriptors()

GENDER_ENUM_TYPE

@Deprecated
public static final String GENDER_ENUM_TYPE

Deprecated.

Gender enum type code.

See Also:

Constant Field Values

Constructor Detail

Address

public Address()

Method Detail

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Description copied from class: Item

Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
Sn example:

 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }

 

Overrides:

createItem in class GeneratedAddress

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

getUser

public User getUser()

Returns the assigned User of this Address.

Returns:

the assigned User of this Address

setUser

public void setUser(User user)

Assigns a new User to this Address.

Parameters:

user - the new User

setGender

@Deprecated
public void setGender(String key,
                                  EnumerationValue value)

Deprecated. use GeneratedAddress.setGender(EnumerationValue), the given key is obsolete

Sets a gender to an address.

getGender

@Deprecated
public EnumerationValue getGender(String key)

Deprecated. use GeneratedAddress.getGender(), the given key is obsolete

Gets the gender from the address.

setOriginal

public void setOriginal(SessionContext ctx,
                        Address value)

Description copied from class: GeneratedAddress

Generated method - Setter of the Address.original attribute.

Overrides:

setOriginal in class GeneratedAddress

value - the original

setOriginal

public void setOriginal(Address value)

Description copied from class: GeneratedAddress

Generated method - Setter of the Address.original attribute.

Overrides:

setOriginal in class GeneratedAddress

Parameters:

value - the original

isDuplicate

public Boolean isDuplicate(SessionContext ctx)

Description copied from class: GeneratedAddress

Generated method - Getter of the Address.duplicate attribute.

Overrides:

isDuplicate in class GeneratedAddress

Returns:

the duplicate

remove

public void remove()
            throws ConsistencyCheckException

Description copied from class: Item

Removes this item.

This method calls Item.remove(SessionContext) with the current session's SessionContext object. See this method for more details.

Overrides:

remove in class Item

Throws:

ConsistencyCheckException - if this item could not be removed for some reason