de.hybris.platform.jalo

Class ExtensibleItem

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

Link, LocalizableItem

public abstract class ExtensibleItem
extends Item

Each extensible item can have several additional properties.

See our Jalo extension tutorial for more informations.

The following state chart presents a the life cycle of a stageable property. Please not that only stageable items have stageable properties. Non-stagable properties have only the states does not exist and unchanged.

Note: If you are using Serializable objects as property values, be sure that the declaring class is in the serverside's classpath. This is a restriction in the current release of hybris platform.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExtensibleItem.ExtensibleItemImpl internal use only!

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 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
ExtensibleItem()

Method Summary

Modifier and Type	Method and Description
protected AttributeAccess	createNonClassAccessor(AttributeDescriptor fieldDescriptor)
Map	getAllProperties() Returns all properties as as Map of key/value mappings.
Map	getAllProperties(SessionContext ctx) Returns all properties as as Map of key/value mappings.
Object	getProperty(SessionContext ctx, String name) Gets a Property.
Object	getProperty(String name) Gets a Property.
Set	getPropertyNames() Returns all used property names (keys) of this item.
Set	getPropertyNames(SessionContext ctx) Returns all used property names (keys) of this item.
Object	removeProperty(SessionContext ctx, String name) Removes a Property.
Object	removeProperty(String name) Removes a Property.
void	setAllProperties(JaloPropertyContainer propertyContainer) Set all properties in the property container, using the staging method set in the current session context.
void	setAllProperties(SessionContext ctx, JaloPropertyContainer propertyContainer) Set all properties of the given property container.
Object	setProperty(SessionContext ctx, String name, Object value) Sets a Property.
Object	setProperty(String name, Object value) Sets a Property.

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, createItem, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getDefaultAttributeModes, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getNonInitialAttributes, 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, 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

Constructor Detail

ExtensibleItem

public ExtensibleItem()

Method Detail

createNonClassAccessor

protected AttributeAccess createNonClassAccessor(AttributeDescriptor fieldDescriptor)

Overrides:

createNonClassAccessor in class Item

getAllProperties

public Map getAllProperties()

Returns all properties as as Map of key/value mappings.

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

Returns:

the key/value map of all non localized properties

getAllProperties

public Map getAllProperties(SessionContext ctx)

Returns all properties as as Map of key/value mappings.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
yes		no		yes if used with staged items, no otherwise

Parameters:

ctx - a SessionContext object.

Returns:

the key/value map of all non localized properties

getPropertyNames

public Set getPropertyNames()

Returns all used property names (keys) of this item.

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

Returns:

set of property names (Strings)

getPropertyNames

public Set getPropertyNames(SessionContext ctx)

Returns all used property names (keys) of this item.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
yes		no		yes if used with staged items, no otherwise

Parameters:

ctx - A SessionContext object

Returns:

set of property names (Strings)

setProperty

public Object setProperty(String name,
                          Object value)

Sets a Property.

This method calls setProperty(SessionContext, String, Object) with the current session's SessionContext object. See this method for more details.

Parameters:

name - the name (key) of the property

value - the value

Returns:

the property that was bound to the name or null if there was no property.

setProperty

public Object setProperty(SessionContext ctx,
                          String name,
                          Object value)

Sets a Property.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
no, this is a setter method.		no		yes if used with staged items, no otherwise

Parameters:

ctx - A SessionContext object

name - the name (key) of the property

value - the value

Returns:

the property that was bound to the name or null if there was no property.

getProperty

public Object getProperty(String name)

Gets a Property.

This method calls getProperty(SessionContext,String) with the current session's SessionContext object. See this method for more details.

Parameters:

name - the name (key) of the property

Returns:

the value bound to the given name.

getProperty

public Object getProperty(SessionContext ctx,
                          String name)

Gets a Property.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
yes		no		yes if used with staged items, no otherwise

Parameters:

ctx - A SessionContext object

name - the name (key) of the property

Returns:

the value bound to the given name.

removeProperty

public Object removeProperty(String name)

Removes a Property.

This method calls removeProperty(SessionContext,String) with the current session's SessionContext object. See this method for more details.

Parameters:

name - the name (key) of the property you want to remove

Returns:

the property that was bound to the name before removal or null if there was no property.

removeProperty

public Object removeProperty(SessionContext ctx,
                             String name)

Removes a Property.

A call to this method is the same like setting a property to null.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
no, this is a setter method.		no		yes if used with staged items, no otherwise

Parameters:

ctx - A SessionContext object

name - the name (key) of the property you want to remove

Returns:

the property that was bound to the name before removal or null if there was no property.

setAllProperties

public void setAllProperties(JaloPropertyContainer propertyContainer)
                      throws ConsistencyCheckException

Set all properties in the property container, using the staging method set in the current session context.

Parameters:

propertyContainer - the property container

Throws:

ConsistencyCheckException - if the property container contains localized properties and the called item is not localizable

setAllProperties

public void setAllProperties(SessionContext ctx,
                             JaloPropertyContainer propertyContainer)
                      throws ConsistencyCheckException

Set all properties of the given property container.

Parameters:

ctx - determines the staging method, but not the localization of properties

propertyContainer - the property container

Throws:

ConsistencyCheckException - if the property container contains localized properties and the called item is not localizable