Package de.hybris.platform.jalo.c2l

Class Region

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.c2l.GeneratedC2LItem

de.hybris.platform.jalo.c2l.C2LItem

de.hybris.platform.jalo.c2l.GeneratedRegion

de.hybris.platform.jalo.c2l.Region

All Implemented Interfaces:

Serializable, Comparable

public class Region
extends GeneratedRegion

The E-Business Platform region item.

A Region is always assigned to one Country. Examples for the use of Region items:

• Address

See Also:

• Serialized Form

Nested Class Summary

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	Description
static final String	CODE	Deprecated. since ages - useGeneratedC2LItem.ISOCODE instead

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

COUNTRY, COUNTRYHANDLER, DEFAULT_INITIAL_ATTRIBUTES

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

ACTIVE, ISOCODE, NAME

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, HJMPTS, 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	Description
Region()

Method Summary

Modifier and Type	Method	Description
protected void	checkConsistencyIsocode(String newIsoCodeRegion, Country country, String composedTypeCode)	is overridden in RegionEJB to allow unique code per country
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)	Has to be implemented for each concrete subtype of item.
String	getCode()	Deprecated. since ages - useGeneratedC2LItem.getIsocode() instead
String	getCode(SessionContext ctx)	Deprecated. since ages - useGeneratedC2LItem.getIsocode(SessionContext) instead
void	setCode(SessionContext ctx, String code)	Deprecated. since ages - useC2LItem.setIsocode(SessionContext, String) instead
void	setCode(String code)	Deprecated. since ages - useGeneratedC2LItem.setIsocode(String) instead
void	setCountry(SessionContext ctx, Country value)	Assigns this Region to the specified Country.

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

getCountry, getCountry, getDefaultAttributeModes, setCountry

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

checkConsistencyActive, getAllNames, getIsoCode, getIsoCode, isActive, setActive, setAllNames, setIsocode, setIsoCode, setIsoCode, toString

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

getAllName, getAllName, getIsocode, getIsocode, getName, getName, isActive, isActiveAsPrimitive, isActiveAsPrimitive, setActive, setActive, setActive, setAllName, setAllName, setIsocode, setName, setName

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

getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, getRelatedItems, setRelatedItems

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, getPartOfRemovedSessionMarker, 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, isMarkModifiedDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, 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, suppressRelation, useTA, writeReplace

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

setTenant

Methods inherited from class java.lang.Object

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

Field Details

CODE

@Deprecated(since="ages",
            forRemoval=false)
public static final String CODE

Deprecated.

since ages - useGeneratedC2LItem.ISOCODE instead

Qualifier constant for attribute code.

See Also:

• Constant Field Values

Constructor Details

Region

public Region()

Method Details

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 GeneratedRegion

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

checkConsistencyIsocode

protected void checkConsistencyIsocode(String newIsoCodeRegion,
 Country country,
 String composedTypeCode)
                                throws ConsistencyCheckException

Description copied from class: C2LItem

is overridden in RegionEJB to allow unique code per country

Overrides:

checkConsistencyIsocode in class C2LItem

Throws:

ConsistencyCheckException

setCountry

public void setCountry(SessionContext ctx,
 Country value)

Assigns this Region to the specified Country.

Overrides:

setCountry in class GeneratedRegion

Parameters:

ctx - the SessionContext which will be used

value - assigns this Region to the specified Country

getCode

@Deprecated(since="ages",
            forRemoval=false)
public String getCode()

Deprecated.

since ages - useGeneratedC2LItem.getIsocode() instead

Returns the code of this region which is unique within the regions of the assigned GeneratedRegion.getCountry().

Returns:

the code of this region which is unique within the regions of the assigned GeneratedRegion.getCountry()

setCode

@Deprecated(since="ages",
            forRemoval=false)
public void setCode(String code)
             throws ConsistencyCheckException

Deprecated.

since ages - useGeneratedC2LItem.setIsocode(String) instead

Sets a new code for this region. This code must be unique within the regions of th assigned Country, otherwise a ConsistencyCheckException is thrown.

Parameters:

code - the new code

Throws:

ConsistencyCheckException - if the new code of this Region is not unique within the regions of the assigned Country

getCode

@Deprecated(since="ages",
            forRemoval=false)
public String getCode(SessionContext ctx)

Deprecated.

since ages - useGeneratedC2LItem.getIsocode(SessionContext) instead

Returns the code of this region which is unique within the regions of the assigned GeneratedRegion.getCountry().

Parameters:

ctx - the SessionContext which will be used

Returns:

the code of this region which is unique within the regions of the assigned Country ( GeneratedRegion.getCountry())

setCode

@Deprecated(since="ages",
            forRemoval=false)
public void setCode(SessionContext ctx,
 String code)
             throws ConsistencyCheckException

Deprecated.

since ages - useC2LItem.setIsocode(SessionContext, String) instead

Sets a new code for this region. This code must be unique within the regions of th assigned Country, otherwise a ConsistencyCheckException is thrown.

Parameters:

ctx - the SessionContext which will be used

code - the new code

Throws:

ConsistencyCheckException - if the new code of this Region is not unique within the regions of the assigned Country