de.hybris.platform.print.jalo

Class Placeholder

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.print.jalo.GeneratedPlaceholder

de.hybris.platform.print.jalo.Placeholder

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedAttributePlaceholder, GeneratedClassificationAttributePlaceholder, GeneratedCrossreferenceTargetPlaceholder, GeneratedCustomPlaceholder, GeneratedExpressionPlaceholder, GeneratedTablePlaceholder

public abstract class Placeholder
extends GeneratedPlaceholder

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 inherited from class de.hybris.platform.print.jalo.GeneratedPlaceholder

CLASSID, COMETCONFIG, COMETCONFIGHANDLER, CONVERT, DEFAULT_INITIAL_ATTRIBUTES, DESCRIPTION, DOMAIN, DOMAINID, LANGUAGE, LOADACTIONID, PLACEHOLDERID, PLACEHOLDERTEMPLATE, PLACEHOLDERTEMPLATEHANDLER, PLACEHOLDERTYPE, POSTPROCESSINGEXPRESSION, PREPROCESSINGEXPRESSION, QUALIFIER, STOREACTIONID, SYNCABLE, SYNCACTIONID, VALUETYPE, WRITABLE

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

Method Summary

Modifier and Type	Method and Description
protected void	checkIDs(Item.ItemAttributeMap allAttributes)
protected Action	createAction(int id, int type)
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
protected void	createMissingActions()
String	getEncodedQualifier()
Object	getRawValue(Item item)
abstract Object	getRawValue(Item item, SessionContext ctx) Returns the value of this placeholder in context of the given item.
Object	getRawValue(Placement placement)
abstract Object	getRawValue(Placement placement, SessionContext ctx) Returns the value of this placeholder in context of the given placement.
protected int	getUniqueActionID(CometConfiguration cometConfig)
String	getValue(Item item)
String	getValue(Item item, Placement placement)
String	getValue(Item item, SessionContext ctx, Placement placement)
String	getValue(Placement placement)
String	getValue(Placement placement, SessionContext ctx)
void	remove(SessionContext ctx) Removes this item.
protected void	removeAction(int id)
void	setRawValue(Item item, Object value)
abstract void	setRawValue(Item item, SessionContext ctx, Object value) Sets the value of this Placeholder in context of the given placement.
void	setRawValue(Placement placement, Object value)
abstract void	setRawValue(Placement placement, SessionContext ctx, Object value) Sets the value of this Placeholder in context of the given placement.
void	setSyncable(SessionContext ctx, Boolean syncable) Generated method - Setter of the Placeholder.syncable attribute.
void	setValue(Item item, SessionContext ctx, String value)
void	setValue(Item item, String value)
void	setValue(Placement placement, SessionContext ctx, String value)
void	setValue(Placement placement, String value)
void	setWritable(SessionContext ctx, Boolean writable) Generated method - Setter of the Placeholder.writable attribute.
static String	valueToString(Object value)

Methods inherited from class de.hybris.platform.print.jalo.GeneratedPlaceholder

getAllDescription, getAllDescription, getClassId, getClassId, getClassIdAsPrimitive, getClassIdAsPrimitive, getCometConfig, getCometConfig, getDefaultAttributeModes, getDescription, getDescription, getDomain, getDomain, getDomainId, getDomainId, getDomainIdAsPrimitive, getDomainIdAsPrimitive, getLanguage, getLanguage, getLoadActionID, getLoadActionID, getLoadActionIDAsPrimitive, getLoadActionIDAsPrimitive, getPlaceholderID, getPlaceholderID, getPlaceholderIDAsPrimitive, getPlaceholderIDAsPrimitive, getPlaceholderTemplate, getPlaceholderTemplate, getPlaceholderType, getPlaceholderType, getPostProcessingExpression, getPostProcessingExpression, getPreProcessingExpression, getPreProcessingExpression, getQualifier, getQualifier, getStoreActionID, getStoreActionID, getStoreActionIDAsPrimitive, getStoreActionIDAsPrimitive, getSyncActionID, getSyncActionID, getSyncActionIDAsPrimitive, getSyncActionIDAsPrimitive, getValueType, getValueType, isConvert, isConvert, isConvertAsPrimitive, isConvertAsPrimitive, isSyncable, isSyncable, isSyncableAsPrimitive, isSyncableAsPrimitive, isWritable, isWritable, isWritableAsPrimitive, isWritableAsPrimitive, setAllDescription, setAllDescription, setClassId, setClassId, setClassId, setClassId, setCometConfig, setCometConfig, setConvert, setConvert, setConvert, setConvert, setDescription, setDescription, setDomain, setDomain, setDomainId, setDomainId, setDomainId, setDomainId, setLanguage, setLanguage, setLoadActionID, setLoadActionID, setLoadActionID, setLoadActionID, setPlaceholderID, setPlaceholderID, setPlaceholderID, setPlaceholderID, setPlaceholderTemplate, setPlaceholderTemplate, setPlaceholderType, setPlaceholderType, setPostProcessingExpression, setPostProcessingExpression, setPreProcessingExpression, setPreProcessingExpression, setQualifier, setQualifier, setStoreActionID, setStoreActionID, setStoreActionID, setStoreActionID, setSyncable, setSyncable, setSyncable, setSyncActionID, setSyncActionID, setSyncActionID, setSyncActionID, setValueType, setValueType, setWritable, setWritable, setWritable

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

Constructor Detail

Placeholder

public Placeholder()

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 GeneratedPlaceholder

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

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Description copied from class: Item

Removes this item.

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

CacheUsage		Language		StagingMethod
n/a (this is a setter method)		no, language doesn't matter for removal		yes if called on a StageableItem, no otherwise

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

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

removeAction

protected void removeAction(int id)
                     throws ConsistencyCheckException

Throws:

ConsistencyCheckException

checkIDs

protected void checkIDs(Item.ItemAttributeMap allAttributes)
                 throws JaloBusinessException

Throws:

JaloBusinessException

getUniqueActionID

protected int getUniqueActionID(CometConfiguration cometConfig)

createMissingActions

protected void createMissingActions()
                             throws JaloBusinessException

Throws:

JaloBusinessException

setSyncable

public void setSyncable(SessionContext ctx,
                        Boolean syncable)

Description copied from class: GeneratedPlaceholder

Generated method - Setter of the Placeholder.syncable attribute.

Overrides:

setSyncable in class GeneratedPlaceholder

syncable - the syncable

setWritable

public void setWritable(SessionContext ctx,
                        Boolean writable)

Description copied from class: GeneratedPlaceholder

Generated method - Setter of the Placeholder.writable attribute.

Overrides:

setWritable in class GeneratedPlaceholder

writable - the writable

createAction

protected Action createAction(int id,
                              int type)
                       throws JaloBusinessException

Throws:

JaloBusinessException

getRawValue

public abstract Object getRawValue(Placement placement,
                                   SessionContext ctx)

Returns the value of this placeholder in context of the given placement.

Parameters:

placement - the placement which this placeholder should be applied to

Returns:

the value of this placeholder in context of the given placement

getRawValue

public final Object getRawValue(Placement placement)

getRawValue

public abstract Object getRawValue(Item item,
                                   SessionContext ctx)

Returns the value of this placeholder in context of the given item.

Parameters:

item - the item which this placeholder should be applied to

Returns:

the value of this placeholder in context of the given item

getRawValue

public final Object getRawValue(Item item)

setRawValue

public abstract void setRawValue(Placement placement,
                                 SessionContext ctx,
                                 Object value)

Sets the value of this Placeholder in context of the given placement.

Parameters:

placement - the placement which this Placeholder should be applied to

ctx - SessionContext to use

value - The new value of this placement

setRawValue

public final void setRawValue(Placement placement,
                              Object value)

setRawValue

public abstract void setRawValue(Item item,
                                 SessionContext ctx,
                                 Object value)

Sets the value of this Placeholder in context of the given placement.

Parameters:

item - the Item which this Placeholder should be applied to

ctx - SessionContext to use

value - The new value of this placement

setRawValue

public final void setRawValue(Item item,
                              Object value)

valueToString

public static String valueToString(Object value)

getEncodedQualifier

public String getEncodedQualifier()

getValue

public final String getValue(Placement placement)

getValue

public final String getValue(Placement placement,
                             SessionContext ctx)

getValue

public final String getValue(Item item)

getValue

public final String getValue(Item item,
                             Placement placement)

getValue

public final String getValue(Item item,
                             SessionContext ctx,
                             Placement placement)

setValue

public void setValue(Item item,
                     String value)
              throws ParseException

Throws:

ParseException

setValue

public void setValue(Item item,
                     SessionContext ctx,
                     String value)
              throws ParseException

Throws:

ParseException

setValue

public void setValue(Placement placement,
                     String value)
              throws ParseException

Throws:

ParseException

setValue

public void setValue(Placement placement,
                     SessionContext ctx,
                     String value)
              throws ParseException

Throws:

ParseException