Class PaymentMode
- All Implemented Interfaces:
Serializable,Comparable
- Direct Known Subclasses:
GeneratedStandardPaymentMode
Basis class of all Payment modes.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem
GenericItem.GenericItemImplNested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LocalizableItem.LocalizableItemImplNested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem
ExtensibleItem.ExtensibleItemImplNested 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, SUPPORTEDDELIVERYMODESFields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LANGUAGE_FALLBACK_ENABLEDFields 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, TYPEFields inherited from class de.hybris.platform.util.BridgeAbstraction
impl, tenant -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddSupportedDeliveryMode(DeliveryMode deliveryMode) Adds support of given delivery mode to this payment mode.protected voidChecks whether or not this it may be removed or not.protected ItemcreateItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.Deprecated.Deprecated.since ages - useGeneratedPaymentMode.getAllName(SessionContext)getCost(AbstractOrder order) Deprecated.getCost(SessionContext ctx, AbstractOrder order) Deprecated.Generated method - Getter of thePaymentMode.supportedDeliveryModesattribute.booleanisSupportedDeliveryMode(DeliveryMode deliveryMode) Checks whether given delivery mode is supported by this payment mode.voidremove(SessionContext ctx) Removes this item.voidremoveSupportedDeliveryMode(DeliveryMode deliveryMode) Removes the support of given delivery mode by this payment mode.voidsetAllDescriptions(SessionContext ctx, Map descriptions) Deprecated.since ages - useGeneratedPaymentMode.setAllDescription(SessionContext, Map)voidsetAllNames(SessionContext ctx, Map names) Deprecated.since ages - useGeneratedPaymentMode.setAllName(SessionContext, Map)voidsetCode(SessionContext ctx, String code) Sets the code of this payment mode.voidSets 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, setPaymentInfoTypeMethods inherited from class de.hybris.platform.jalo.GenericItem
getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, getRelatedItems, setRelatedItemsMethods 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, setLocalizedPropertyMethods inherited from class de.hybris.platform.jalo.ExtensibleItem
createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setPropertyMethods 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, writeReplaceMethods inherited from class de.hybris.platform.util.BridgeAbstraction
setTenant
-
Constructor Details
-
PaymentMode
public PaymentMode()
-
-
Method Details
-
createItem
protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException Description copied from class:ItemHas 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. ) duringComposedType.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:
createItemin classGenericItem- Parameters:
ctx- the current session context which this item is created withintype- 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 - 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 - useGeneratedPaymentMode.setAllName(SessionContext, Map)Sets names (in all languages).- Parameters:
ctx- A SessionContext objectnames- map with following combination key:language, value:name
-
getAllDescriptions
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 objectdescriptions- map with following combination key:language, value:description
-
setCode
Sets the code of this payment mode.- Overrides:
setCodein classGeneratedPaymentMode- Parameters:
code- new code for this payment mode- Throws:
ConsistencyCheckException- if there is already a payment mode with given code
-
setCode
Sets the code of this payment mode.- Overrides:
setCodein classGeneratedPaymentMode- 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.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 contextorder- the order to calculate costs for- Throws:
JaloPaymentModeException
-
getCost
@Deprecated(since="ages", forRemoval=false) public PriceValue getCost(AbstractOrder order) throws JaloPaymentModeException Deprecated.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
Adds support of given delivery mode to this payment mode. -
removeSupportedDeliveryMode
Removes the support of given delivery mode by this payment mode. -
isSupportedDeliveryMode
Checks whether given delivery mode is supported by this payment mode.- Parameters:
deliveryMode- delivery mode to check
-
getSupportedDeliveryModes
Description copied from class:GeneratedPaymentModeGenerated method - Getter of thePaymentMode.supportedDeliveryModesattribute.- Specified by:
getSupportedDeliveryModesin classGeneratedPaymentMode- Returns:
- the supportedDeliveryModes
-
remove
Description copied from class:ItemRemoves 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:
removein classItem- Parameters:
ctx- A SessionContext object- Throws:
ConsistencyCheckException- if this item could not be removed for some reason
-
checkRemovable
Description copied from class:ItemChecks whether or not this it may be removed or not. Called before the actual removal process.- Overrides:
checkRemovablein classItem- Throws:
ConsistencyCheckException- to indicate that the item cannot be removed
-
GeneratedPaymentMode.getAllDescription(SessionContext)