Package de.hybris.platform.jalo.order.payment

Class PaymentMode

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.payment.GeneratedPaymentMode

de.hybris.platform.jalo.order.payment.PaymentMode

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedStandardPaymentMode

public class PaymentMode
extends GeneratedPaymentMode

Basis class of all Payment modes.

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.payment.GeneratedPaymentMode

ACTIVE, CODE, DEFAULT_INITIAL_ATTRIBUTES, DESCRIPTION, NAME, PAYMENTINFOTYPE, SUPPORTEDDELIVERYMODES

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

Method Summary

Modifier and Type	Method	Description
void	addSupportedDeliveryMode(DeliveryMode deliveryMode)	Adds support of given delivery mode to this 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. since ages - useGeneratedPaymentMode.getAllDescription(SessionContext)
Map	getAllNames(SessionContext ctx)	Deprecated. since ages - useGeneratedPaymentMode.getAllName(SessionContext)
PriceValue	getCost(AbstractOrder order)	Deprecated. since ages - use FindPaymentCostStrategy.getPaymentCost(de.hybris.platform.core.model.order.AbstractOrderModel)
PriceValue	getCost(SessionContext ctx, AbstractOrder order)	Deprecated. since ages - use FindPaymentCostStrategy.getPaymentCost(de.hybris.platform.core.model.order.AbstractOrderModel)
Collection<DeliveryMode>	getSupportedDeliveryModes(SessionContext ctx)	Generated method - Getter of the PaymentMode.supportedDeliveryModes attribute.
boolean	isSupportedDeliveryMode(DeliveryMode deliveryMode)	Checks whether given delivery mode is supported by this payment mode.
void	remove(SessionContext ctx)	Removes this item.
void	removeSupportedDeliveryMode(DeliveryMode deliveryMode)	Removes the support of given delivery mode by this payment mode.
void	setAllDescriptions(SessionContext ctx, Map descriptions)	Deprecated. since ages - useGeneratedPaymentMode.setAllDescription(SessionContext, Map)
void	setAllNames(SessionContext ctx, Map names)	Deprecated. since ages - useGeneratedPaymentMode.setAllName(SessionContext, Map)
void	setCode(SessionContext ctx, String code)	Sets the code of this payment mode.
void	setCode(String code)	Sets the code of this payment mode.

Methods inherited from class de.hybris.platform.jalo.order.payment.GeneratedPaymentMode

getAllDescription, getAllDescription, getAllName, getAllName, getCode, getCode, getDefaultAttributeModes, getDescription, getDescription, getName, getName, getPaymentInfoType, getPaymentInfoType, getSupportedDeliveryModes, isActive, isActive, isActiveAsPrimitive, isActiveAsPrimitive, setActive, setActive, setActive, setActive, setAllDescription, setAllDescription, setAllName, setAllName, setDescription, setDescription, setName, setName, setPaymentInfoType, setPaymentInfoType

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

Constructor Details

PaymentMode

public PaymentMode()

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 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(since="ages",
            forRemoval=false)
public Map getAllNames(SessionContext ctx)

Deprecated.

since ages - useGeneratedPaymentMode.getAllName(SessionContext)

Gets all names (in all languages).

Parameters:

ctx - A SessionContext object

Returns:

map with following combination key:language, value:name

setAllNames

@Deprecated(since="ages",
            forRemoval=false)
public void setAllNames(SessionContext ctx,
 Map names)

Deprecated.

since ages - useGeneratedPaymentMode.setAllName(SessionContext, Map)

Sets names (in all languages).

Parameters:

ctx - A SessionContext object

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

getAllDescriptions

@Deprecated(since="ages",
            forRemoval=false)
public Map getAllDescriptions(SessionContext ctx)

Deprecated.

since ages - useGeneratedPaymentMode.getAllDescription(SessionContext)

Gets all descriptions (in all languages).

Parameters:

ctx - A SessionContext object

Returns:

map with following combination key:language, value:description

setAllDescriptions

@Deprecated(since="ages",
            forRemoval=false)
public void setAllDescriptions(SessionContext ctx,
 Map descriptions)

Deprecated.

since ages - useGeneratedPaymentMode.setAllDescription(SessionContext, Map)

Gets 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 payment mode.

Overrides:

setCode in class GeneratedPaymentMode

Parameters:

code - new code for this payment mode

Throws:

ConsistencyCheckException - if there is already a payment mode with given code

setCode

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

Sets the code of this payment mode.

Overrides:

setCode in class GeneratedPaymentMode

Parameters:

code - new code for this payment mode

Throws:

ConsistencyCheckException - if there is already a payment mode with given code

getCost

@Deprecated(since="ages",
            forRemoval=false)
public PriceValue getCost(SessionContext ctx,
 AbstractOrder order)
                   throws JaloPaymentModeException

Deprecated.

since ages - use FindPaymentCostStrategy.getPaymentCost(de.hybris.platform.core.model.order.AbstractOrderModel)

Calculates the payment 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:

JaloPaymentModeException

getCost

@Deprecated(since="ages",
            forRemoval=false)
public PriceValue getCost(AbstractOrder order)
                   throws JaloPaymentModeException

Deprecated.

since ages - use FindPaymentCostStrategy.getPaymentCost(de.hybris.platform.core.model.order.AbstractOrderModel)

Calculates the payment 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:

JaloPaymentModeException

addSupportedDeliveryMode

public void addSupportedDeliveryMode(DeliveryMode deliveryMode)

Adds support of given delivery mode to this payment mode.

removeSupportedDeliveryMode

public void removeSupportedDeliveryMode(DeliveryMode deliveryMode)

Removes the support of given delivery mode by this payment mode.

isSupportedDeliveryMode

public boolean isSupportedDeliveryMode(DeliveryMode deliveryMode)

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

Parameters:

deliveryMode - delivery mode to check

getSupportedDeliveryModes

public Collection<DeliveryMode> getSupportedDeliveryModes(SessionContext ctx)

Description copied from class: GeneratedPaymentMode

Generated method - Getter of the PaymentMode.supportedDeliveryModes attribute.

Specified by:

getSupportedDeliveryModes in class GeneratedPaymentMode

Returns:

the supportedDeliveryModes

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

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