de.hybris.platform.jalo.order.delivery

Class DeliveryMode

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.order.delivery.GeneratedDeliveryMode

de.hybris.platform.jalo.order.delivery.DeliveryMode

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedPickUpDeliveryMode, GeneratedZoneDeliveryMode, TestDeliveryMode

public class DeliveryMode
extends GeneratedDeliveryMode

Basis class of all DeliveryModes.

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.jalo.order.delivery.GeneratedDeliveryMode

ACTIVE, CODE, DEFAULT_INITIAL_ATTRIBUTES, DESCRIPTION, NAME, SUPPORTEDPAYMENTMODES, SUPPORTEDPAYMENTMODESINTERNAL

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

Method Summary

Modifier and Type	Method and Description
void	addSupportedPaymentMode(PaymentMode paymentMode) Adds support of given payment mode.
protected void	checkRemovable(SessionContext ctx) Checks whether or not this it may be removed or not.
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
Map	getAllDescriptions(SessionContext ctx) Deprecated. use GeneratedDeliveryMode.getAllDescription(SessionContext)
Map	getAllNames(SessionContext ctx) Deprecated. use GeneratedDeliveryMode.getAllName(SessionContext)
PriceValue	getCost(AbstractOrder order) Calculates the delivery cost of this mode for a given order.
PriceValue	getCost(SessionContext ctx, AbstractOrder order) Calculates the delivery cost of this mode for a given order.
Collection<PaymentMode>	getSupportedPaymentModes(SessionContext ctx) Gets all payment modes supported by this delivery mode.
boolean	isSupportedPaymentMode(PaymentMode paymentMode) Checks whether given payment mode is supported for this delivery mode.
void	removeSupportedPaymentMode(PaymentMode paymentMode) Removes support of given payment mode.
void	setAllDescriptions(SessionContext ctx, Map descriptions) Deprecated. use GeneratedDeliveryMode.setAllDescription(SessionContext, Map)
void	setAllNames(SessionContext ctx, Map names) Deprecated. use GeneratedDeliveryMode.setAllName(SessionContext, Map)
void	setCode(SessionContext ctx, String code) Sets the code of this delivery mode.
void	setCode(String code) Sets the code of this delivery mode.
void	setSupportedPaymentModes(SessionContext ctx, Collection paymentModes) Sets all payment modes supported by this delivery mode.

Methods inherited from class de.hybris.platform.jalo.order.delivery.GeneratedDeliveryMode

getAllDescription, getAllDescription, getAllName, getAllName, getCode, getCode, getDefaultAttributeModes, getDescription, getDescription, getName, getName, getSupportedPaymentModes, isActive, isActive, isActiveAsPrimitive, isActiveAsPrimitive, setActive, setActive, setActive, setActive, setAllDescription, setAllDescription, setAllName, setAllName, setDescription, setDescription, setName, setName, setSupportedPaymentModes

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, 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, 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

DeliveryMode

public DeliveryMode()

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 GenericItem

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

getAllNames

@Deprecated
public Map getAllNames(SessionContext ctx)

Deprecated. use GeneratedDeliveryMode.getAllName(SessionContext)

Gets all names (in all languages).

Parameters:

ctx - A SessionContext object

Returns:

map with following combination key:language, value:name

setAllNames

@Deprecated
public void setAllNames(SessionContext ctx,
                                    Map names)

Deprecated. use GeneratedDeliveryMode.setAllName(SessionContext, Map)

Sets names (in all languages).

Parameters:

ctx - A SessionContext object

names - map with following combination key:language, value:name

getAllDescriptions

@Deprecated
public Map getAllDescriptions(SessionContext ctx)

Deprecated. use GeneratedDeliveryMode.getAllDescription(SessionContext)

Gets all descriptions (in all languages).

Parameters:

ctx - A SessionContext object

Returns:

map with following combination key:language, value:description

setAllDescriptions

@Deprecated
public void setAllDescriptions(SessionContext ctx,
                                           Map descriptions)

Deprecated. use GeneratedDeliveryMode.setAllDescription(SessionContext, Map)

Sets descriptions (in all languages).

Parameters:

ctx - A SessionContext object

descriptions - map with following combination key:language, value:description

setCode

public void setCode(String code)
             throws ConsistencyCheckException

Sets the code of this delivery mode.

Overrides:

setCode in class GeneratedDeliveryMode

Parameters:

code - new code for this mode

Throws:

ConsistencyCheckException - if there is a mode given code already

setCode

public void setCode(SessionContext ctx,
                    String code)
             throws ConsistencyCheckException

Sets the code of this delivery mode.

Overrides:

setCode in class GeneratedDeliveryMode

Parameters:

code - new code for this mode

Throws:

ConsistencyCheckException - if there is a mode given code already

getCost

public PriceValue getCost(SessionContext ctx,
                          AbstractOrder order)
                   throws JaloDeliveryModeException

Calculates the delivery cost of this mode for a given order. This is called when the specified order is calculated the first time or recalculated.

This default implementation always returns 0 costs. each subtype may override this method to implement its own cost model.

Parameters:

ctx - session context

order - the order to calculate costs for

Throws:

JaloDeliveryModeException

getCost

public PriceValue getCost(AbstractOrder order)
                   throws JaloDeliveryModeException

Calculates the delivery cost of this mode for a given order. This is called when the specified order is calculated the first time or recalculated.

This default implementation always returns 0 costs.

Parameters:

order - the order to calculate costs for

Throws:

JaloDeliveryModeException

getSupportedPaymentModes

public Collection<PaymentMode> getSupportedPaymentModes(SessionContext ctx)

Gets all payment modes supported by this delivery mode.

Specified by:

getSupportedPaymentModes in class GeneratedDeliveryMode

Returns:

the supportedPaymentModes

setSupportedPaymentModes

public void setSupportedPaymentModes(SessionContext ctx,
                                     Collection paymentModes)

Sets all payment modes supported by this delivery mode.

Specified by:

setSupportedPaymentModes in class GeneratedDeliveryMode

paymentModes - the supportedPaymentModes

addSupportedPaymentMode

public void addSupportedPaymentMode(PaymentMode paymentMode)

Adds support of given payment mode.

removeSupportedPaymentMode

public void removeSupportedPaymentMode(PaymentMode paymentMode)

Removes support of given payment mode.

isSupportedPaymentMode

public boolean isSupportedPaymentMode(PaymentMode paymentMode)

Checks whether given payment mode is supported for this delivery mode.

checkRemovable

protected void checkRemovable(SessionContext ctx)
                       throws ConsistencyCheckException

Description copied from class: Item

Checks whether or not this it may be removed or not. Called before the actual removal process.

Overrides:

checkRemovable in class Item

Throws:

ConsistencyCheckException - to indicate that the item cannot be removed