de.hybris.platform.promotions.jalo

Class CachedPromotionResult

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.promotions.jalo.GeneratedPromotionResult

de.hybris.platform.promotions.jalo.PromotionResult

de.hybris.platform.promotions.jalo.GeneratedCachedPromotionResult

de.hybris.platform.promotions.jalo.CachedPromotionResult

All Implemented Interfaces:

JaloOnlyItem, Serializable, Comparable

public class CachedPromotionResult
extends GeneratedCachedPromotionResult
implements JaloOnlyItem

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.promotions.jalo.GeneratedCachedPromotionResult

CACHEDACTIONS, CACHEDCONSUMEDENTRIES, DEFAULT_INITIAL_ATTRIBUTES

Fields inherited from class de.hybris.platform.promotions.jalo.GeneratedPromotionResult

ACTIONS, ALLPROMOTIONACTIONS, ALLPROMOTIONACTIONSHANDLER, CERTAINTY, CONSUMEDENTRIES, CUSTOM, ORDER, ORDERHANDLER, PROMOTION

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

Method Summary

Modifier and Type	Method and Description
void	addAction(SessionContext ctx, AbstractPromotionAction action) Adds an action to the promotion results.
void	addConsumedEntry(SessionContext ctx, PromotionOrderEntryConsumed poec) Adds a consumed entry to the current result.
void	addToAllPromotionActions(SessionContext ctx, AbstractPromotionAction action) Generated method - Adds value to allPromotionActions.
void	addToCachedActions(SessionContext ctx, AbstractPromotionAction action)
void	addToCachedConsumedEntries(SessionContext ctx, CachedPromotionOrderEntryConsumed poec)
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
Object	doGetAttribute(SessionContext ctx, String attrQualifier) Custom attribute access as part of JaloOnlyItem contract.
void	doSetAttribute(SessionContext ctx, String attrQualifier, Object value) Custom attribute access as part of JaloOnlyItem contract.
Collection<AbstractPromotionAction>	getActions(SessionContext ctx) Gets the collection of AbstractPromotionAction instances.
Set<AbstractPromotionAction>	getAllPromotionActions(SessionContext ctx) Generated method - Getter of the PromotionResult.allPromotionActions attribute.
Collection<AbstractPromotionAction>	getCachedActions(SessionContext ctx) Generated method - Getter of the CachedPromotionResult.cachedActions attribute.
Collection<CachedPromotionOrderEntryConsumed>	getCachedConsumedEntries(SessionContext sessionContext) Generated method - Getter of the CachedPromotionResult.cachedConsumedEntries attribute.
Float	getCertainty(SessionContext ctx) Generated method - Getter of the PromotionResult.certainty attribute.
Collection<PromotionOrderEntryConsumed>	getConsumedEntries(SessionContext ctx) Gets the collection of PromotionOrderEntryConsumed consumed.
String	getCustom(SessionContext ctx) Generated method - Getter of the PromotionResult.custom attribute.
AbstractOrder	getOrder(SessionContext ctx) Generated method - Getter of the PromotionResult.order attribute.
AbstractPromotion	getPromotion(SessionContext ctx) Generated method - Getter of the PromotionResult.promotion attribute.
ComposedType	provideComposedType() Provides composed as part of JaloOnlyItem contract.
Date	provideCreationTime() Provides creation time as part of JaloOnlyItem contract.
Date	provideModificationTime() Provides modification time as part of JaloOnlyItem contract.
PK	providePK() Provides PK part of JaloOnlyItem contract.
void	removeConsumedEntry(SessionContext ctx, PromotionOrderEntryConsumed poec) Removes a consumed entry from the current result.
void	removeFromAllPromotionActions(SessionContext ctx, AbstractPromotionAction action) Generated method - Removes value from allPromotionActions.
void	removeFromCachedActions(SessionContext ctx, AbstractPromotionAction action)
void	removeFromCachedConsumedEntries(SessionContext ctx, CachedPromotionOrderEntryConsumed poec)
void	removeJaloOnly() Custom removal logic as part of JaloOnlyItem contract.
void	setActions(SessionContext ctx, Collection actions) Sets the collection of AbstractPromotionAction instance.
void	setAllPromotionActions(SessionContext ctx, Set<AbstractPromotionAction> actions) Generated method - Setter of the PromotionResult.allPromotionActions attribute.
void	setCachedActions(SessionContext ctx, Collection<AbstractPromotionAction> abstractPromotionActions) Generated method - Setter of the CachedPromotionResult.cachedActions attribute.
void	setCachedConsumedEntries(SessionContext ctx, Collection<CachedPromotionOrderEntryConsumed> cachedConsumedEntries) Generated method - Setter of the CachedPromotionResult.cachedConsumedEntries attribute.
void	setCertainty(SessionContext ctx, Float certainty) Generated method - Setter of the PromotionResult.certainty attribute.
void	setConsumedEntries(SessionContext ctx, Collection entries) Sets the collection of PromotionOrderEntryConsumed consumed.
void	setCustom(SessionContext ctx, String custom) Generated method - Setter of the PromotionResult.custom attribute.
void	setOrder(SessionContext ctx, AbstractOrder order) Generated method - Setter of the PromotionResult.order attribute.
void	setPromotion(SessionContext ctx, AbstractPromotion promotion) Generated method - Setter of the PromotionResult.promotion attribute.

Methods inherited from class de.hybris.platform.promotions.jalo.GeneratedCachedPromotionResult

getCachedActions, getCachedConsumedEntries, getDefaultAttributeModes, setCachedActions, setCachedConsumedEntries

Methods inherited from class de.hybris.platform.promotions.jalo.PromotionResult

apply, apply, deepCloneAllActions, deepCloneConsumedEntriesAndAttachToOrder, deepCloneConsumedEntryAndAttachToOrder, findOrderEntryWithEntryNumber, getConsumedCount, getConsumedCount, getCouldFire, getCouldFire, getDataUnigueKey, getDescription, getDescription, getDescription, getFired, getFired, getTotalDiscount, getTotalDiscount, isApplied, isApplied, isAppliedToOrder, isValid, remove, transferToOrder, undo, undo

Methods inherited from class de.hybris.platform.promotions.jalo.GeneratedPromotionResult

addToAllPromotionActions, getActions, getAllPromotionActions, getCertainty, getCertaintyAsPrimitive, getCertaintyAsPrimitive, getConsumedEntries, getCustom, getOrder, getPromotion, removeFromAllPromotionActions, setActions, setAllPromotionActions, setCertainty, setCertainty, setCertainty, setConsumedEntries, setCustom, setOrder, setPromotion

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

CachedPromotionResult

public CachedPromotionResult()

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 GeneratedPromotionResult

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

getCertainty

public Float getCertainty(SessionContext ctx)

Description copied from class: GeneratedPromotionResult

Generated method - Getter of the PromotionResult.certainty attribute.

Overrides:

getCertainty in class GeneratedPromotionResult

Returns:

the certainty - Certainty

setCertainty

public void setCertainty(SessionContext ctx,
                         Float certainty)

Description copied from class: GeneratedPromotionResult

Generated method - Setter of the PromotionResult.certainty attribute.

Overrides:

setCertainty in class GeneratedPromotionResult

certainty - the certainty - Certainty

getCustom

public String getCustom(SessionContext ctx)

Description copied from class: GeneratedPromotionResult

Generated method - Getter of the PromotionResult.custom attribute.

Overrides:

getCustom in class GeneratedPromotionResult

Returns:

the custom - Custom data stored on this promotion result by the promotion.

setCustom

public void setCustom(SessionContext ctx,
                      String custom)

Description copied from class: GeneratedPromotionResult

Generated method - Setter of the PromotionResult.custom attribute.

Overrides:

setCustom in class GeneratedPromotionResult

custom - the custom - Custom data stored on this promotion result by the promotion.

getOrder

public AbstractOrder getOrder(SessionContext ctx)

Description copied from class: GeneratedPromotionResult

Generated method - Getter of the PromotionResult.order attribute.

Overrides:

getOrder in class GeneratedPromotionResult

Returns:

the order

setOrder

public void setOrder(SessionContext ctx,
                     AbstractOrder order)

Description copied from class: GeneratedPromotionResult

Generated method - Setter of the PromotionResult.order attribute.

Overrides:

setOrder in class GeneratedPromotionResult

order - the order

getPromotion

public AbstractPromotion getPromotion(SessionContext ctx)

Description copied from class: GeneratedPromotionResult

Generated method - Getter of the PromotionResult.promotion attribute.

Overrides:

getPromotion in class GeneratedPromotionResult

Returns:

the promotion - The promotion

setPromotion

public void setPromotion(SessionContext ctx,
                         AbstractPromotion promotion)

Description copied from class: GeneratedPromotionResult

Generated method - Setter of the PromotionResult.promotion attribute.

Overrides:

setPromotion in class GeneratedPromotionResult

promotion - the promotion - The promotion

addAction

public void addAction(SessionContext ctx,
                      AbstractPromotionAction action)

Description copied from class: PromotionResult

Adds an action to the promotion results.

Overrides:

addAction in class PromotionResult

Parameters:

ctx - The hybris context

action - The action to add

getActions

public Collection<AbstractPromotionAction> getActions(SessionContext ctx)

Description copied from class: PromotionResult

Gets the collection of AbstractPromotionAction instances.

Overrides:

getActions in class PromotionResult

Parameters:

ctx - The hybris session context

Returns:

A collection of AbstractPromotionAction instances attached to this result.

setActions

public void setActions(SessionContext ctx,
                       Collection actions)

Description copied from class: PromotionResult

Sets the collection of AbstractPromotionAction instance.

The AbstractPromotionAction instances associated with this promotion result are owned (and part of) this result. They cannot belong to another instance, therefore when setting the collection any AbstractPromotionAction instances previously associated with this result, that are no longer associated are deleted from the database.

Overrides:

setActions in class PromotionResult

Parameters:

ctx - The hybris session context

actions - the collection of actions

getAllPromotionActions

public Set<AbstractPromotionAction> getAllPromotionActions(SessionContext ctx)

Description copied from class: GeneratedPromotionResult

Generated method - Getter of the PromotionResult.allPromotionActions attribute.

Overrides:

getAllPromotionActions in class GeneratedPromotionResult

Returns:

the allPromotionActions

setAllPromotionActions

public void setAllPromotionActions(SessionContext ctx,
                                   Set<AbstractPromotionAction> actions)

Description copied from class: GeneratedPromotionResult

Generated method - Setter of the PromotionResult.allPromotionActions attribute.

Overrides:

setAllPromotionActions in class GeneratedPromotionResult

actions - the allPromotionActions

addToAllPromotionActions

public void addToAllPromotionActions(SessionContext ctx,
                                     AbstractPromotionAction action)

Description copied from class: GeneratedPromotionResult

Generated method - Adds value to allPromotionActions.

Overrides:

addToAllPromotionActions in class GeneratedPromotionResult

action - the item to add to allPromotionActions

removeFromAllPromotionActions

public void removeFromAllPromotionActions(SessionContext ctx,
                                          AbstractPromotionAction action)

Description copied from class: GeneratedPromotionResult

Generated method - Removes value from allPromotionActions.

Overrides:

removeFromAllPromotionActions in class GeneratedPromotionResult

action - the item to remove from allPromotionActions

getCachedActions

public Collection<AbstractPromotionAction> getCachedActions(SessionContext ctx)

Description copied from class: GeneratedCachedPromotionResult

Generated method - Getter of the CachedPromotionResult.cachedActions attribute.

Specified by:

getCachedActions in class GeneratedCachedPromotionResult

Returns:

the cachedActions - Cached list of actions

setCachedActions

public void setCachedActions(SessionContext ctx,
                             Collection<AbstractPromotionAction> abstractPromotionActions)

Description copied from class: GeneratedCachedPromotionResult

Generated method - Setter of the CachedPromotionResult.cachedActions attribute.

Specified by:

setCachedActions in class GeneratedCachedPromotionResult

abstractPromotionActions - the cachedActions - Cached list of actions

addToCachedActions

public void addToCachedActions(SessionContext ctx,
                               AbstractPromotionAction action)

removeFromCachedActions

public void removeFromCachedActions(SessionContext ctx,
                                    AbstractPromotionAction action)

getCachedConsumedEntries

public Collection<CachedPromotionOrderEntryConsumed> getCachedConsumedEntries(SessionContext sessionContext)

Description copied from class: GeneratedCachedPromotionResult

Generated method - Getter of the CachedPromotionResult.cachedConsumedEntries attribute.

Specified by:

getCachedConsumedEntries in class GeneratedCachedPromotionResult

Returns:

the cachedConsumedEntries - Cached list of consumed entries

setCachedConsumedEntries

public void setCachedConsumedEntries(SessionContext ctx,
                                     Collection<CachedPromotionOrderEntryConsumed> cachedConsumedEntries)

Description copied from class: GeneratedCachedPromotionResult

Generated method - Setter of the CachedPromotionResult.cachedConsumedEntries attribute.

Specified by:

setCachedConsumedEntries in class GeneratedCachedPromotionResult

cachedConsumedEntries - the cachedConsumedEntries - Cached list of consumed entries

addToCachedConsumedEntries

public void addToCachedConsumedEntries(SessionContext ctx,
                                       CachedPromotionOrderEntryConsumed poec)

removeFromCachedConsumedEntries

public void removeFromCachedConsumedEntries(SessionContext ctx,
                                            CachedPromotionOrderEntryConsumed poec)

addConsumedEntry

public void addConsumedEntry(SessionContext ctx,
                             PromotionOrderEntryConsumed poec)

Description copied from class: PromotionResult

Adds a consumed entry to the current result.

Overrides:

addConsumedEntry in class PromotionResult

Parameters:

ctx - the hybris context

poec - the entry to add

removeConsumedEntry

public void removeConsumedEntry(SessionContext ctx,
                                PromotionOrderEntryConsumed poec)

Description copied from class: PromotionResult

Removes a consumed entry from the current result.

Overrides:

removeConsumedEntry in class PromotionResult

Parameters:

ctx - the hybris context

poec - the entry to remove

getConsumedEntries

public Collection<PromotionOrderEntryConsumed> getConsumedEntries(SessionContext ctx)

Description copied from class: PromotionResult

Gets the collection of PromotionOrderEntryConsumed consumed.

Overrides:

getConsumedEntries in class PromotionResult

Parameters:

ctx - The hybris session context

Returns:

A collection of PromotionOrderEntryConsumed consumed by this result.

setConsumedEntries

public void setConsumedEntries(SessionContext ctx,
                               Collection entries)

Description copied from class: PromotionResult

Sets the collection of PromotionOrderEntryConsumed consumed.

The PromotionOrderEntryConsumed instances associated with this promotion result are owned (and part of) this result. They cannot belong to another instance, therefore when setting the collection any PromotionOrderEntryConsumed instances previously associated with this result, that are no longer associated are deleted from the database.

Overrides:

setConsumedEntries in class PromotionResult

Parameters:

ctx - The hybris session context

entries - the collection of consumed entries

provideComposedType

public final ComposedType provideComposedType()

Provides composed as part of JaloOnlyItem contract. Never call directly

Specified by:

provideComposedType in interface JaloOnlyItem

Returns:

ComposedType of this item

provideCreationTime

public final Date provideCreationTime()

Provides creation time as part of JaloOnlyItem contract. Never call directly

Specified by:

provideCreationTime in interface JaloOnlyItem

Returns:

creation time date of this item

provideModificationTime

public final Date provideModificationTime()

Provides modification time as part of JaloOnlyItem contract. Never call directly

Specified by:

provideModificationTime in interface JaloOnlyItem

Returns:

modification time date of this item

providePK

public final PK providePK()

Provides PK part of JaloOnlyItem contract. Never call directly

Specified by:

providePK in interface JaloOnlyItem

Returns:

PK of this item

removeJaloOnly

public void removeJaloOnly()
                    throws ConsistencyCheckException

Custom removal logic as part of JaloOnlyItem contract. Never call directly

Specified by:

removeJaloOnly in interface JaloOnlyItem

Throws:

ConsistencyCheckException - to signal that this item removal failed

doGetAttribute

public Object doGetAttribute(SessionContext ctx,
                             String attrQualifier)
                      throws JaloInvalidParameterException,
                             JaloSecurityException

Custom attribute access as part of JaloOnlyItem contract. Never call directly

Specified by:

doGetAttribute in interface JaloOnlyItem

Parameters:

ctx - the session context

attrQualifier - the qualifier of the requested attribute

Returns:

the attribute value

Throws:

JaloInvalidParameterException - in case no value could be read for this attribute

JaloSecurityException

doSetAttribute

public void doSetAttribute(SessionContext ctx,
                           String attrQualifier,
                           Object value)
                    throws JaloInvalidParameterException,
                           JaloSecurityException,
                           JaloBusinessException

Custom attribute access as part of JaloOnlyItem contract. Never call directly

Specified by:

doSetAttribute in interface JaloOnlyItem

Parameters:

ctx - the session context

attrQualifier - the qualifier of the requested attribute

value - the new attribute value

Throws:

JaloInvalidParameterException - in case the value could not be written for this attribute

JaloSecurityException - in case the session user is not allowed to write this attribute

JaloBusinessException - in case any other error occured