Package de.hybris.platform.jalo.order.price

Class Tax

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.price.GeneratedTax

de.hybris.platform.jalo.order.price.Tax

All Implemented Interfaces:

Serializable, Comparable

public class Tax
extends GeneratedTax

The hybris platform tax item.

A tax object contains a localizable name, a code and a value. By now there are only relative taxes, which means that the value should be taken from [ 0 , 100 ] which denotes a percentual tax rate.

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

Modifier and Type	Field	Description
static final String	EXTERNAL_KEY	The external key - search constant for OrderManager.searchTaxes(de.hybris.platform.jalo.SearchContext).
static final String	VALUE_END	The value range end - search constant for OrderManager.searchTaxes(de.hybris.platform.jalo.SearchContext).
static final String	VALUE_START	The value range start - search constant for OrderManager.searchTaxes(de.hybris.platform.jalo.SearchContext).

Fields inherited from class de.hybris.platform.jalo.order.price.GeneratedTax

ABSOLUTE, CODE, CURRENCY, DEFAULT_INITIAL_ATTRIBUTES, NAME, VALUE

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

Method Summary

Modifier and Type	Method	Description
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)	Has to be implemented for each concrete subtype of item.
Map	getAllNames(SessionContext ctx)	Deprecated. since ages - useGeneratedTax.getAllName(SessionContext)
Boolean	isAbsolute(SessionContext ctx)	Generated method - Getter of the Tax.absolute attribute.
void	setAllNames(SessionContext ctx, Map names)	Deprecated. since ages - useGeneratedTax.setAllName(SessionContext, Map)
void	setCode(SessionContext ctx, String code)	Changes the code of this tax.

Methods inherited from class de.hybris.platform.jalo.order.price.GeneratedTax

getAllName, getAllName, getCode, getCode, getCurrency, getCurrency, getDefaultAttributeModes, getName, getName, getValue, getValue, getValueAsPrimitive, getValueAsPrimitive, isAbsolute, isAbsoluteAsPrimitive, isAbsoluteAsPrimitive, setAllName, setAllName, setCode, setCurrency, setCurrency, setName, setName, setValue, setValue, setValue, setValue

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

Field Details

EXTERNAL_KEY

public static final String EXTERNAL_KEY

The external key - search constant for OrderManager.searchTaxes(de.hybris.platform.jalo.SearchContext).

See Also:

• Constant Field Values

VALUE_START

public static final String VALUE_START

The value range start - search constant for OrderManager.searchTaxes(de.hybris.platform.jalo.SearchContext).

See Also:

• Constant Field Values

VALUE_END

public static final String VALUE_END

The value range end - search constant for OrderManager.searchTaxes(de.hybris.platform.jalo.SearchContext).

See Also:

• Constant Field Values

Constructor Details

Tax

public Tax()

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 - useGeneratedTax.getAllName(SessionContext)

Gives 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 - useGeneratedTax.setAllName(SessionContext, Map)

Sets names (in all languages)

Parameters:

ctx - A SessionContext object

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

setCode

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

Changes the code of this tax.

Overrides:

setCode in class GeneratedTax

Parameters:

code -

Throws:

ConsistencyCheckException - if the specified code is already used by another tax object

isAbsolute

public Boolean isAbsolute(SessionContext ctx)

Description copied from class: GeneratedTax

Generated method - Getter of the Tax.absolute attribute.

Specified by:

isAbsolute in class GeneratedTax

Returns:

the absolute