Package de.hybris.platform.cms2.jalo.contents.components

Class AbstractCMSComponent

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.cms2.jalo.contents.GeneratedCMSItem

de.hybris.platform.cms2.jalo.contents.CMSItem

de.hybris.platform.cms2.jalo.contents.components.GeneratedAbstractCMSComponent

de.hybris.platform.cms2.jalo.contents.components.AbstractCMSComponent

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedAbstractCMSComponentContainer, GeneratedSimpleCMSComponent

public abstract class AbstractCMSComponent
extends GeneratedAbstractCMSComponent

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.cms2.jalo.contents.components.GeneratedAbstractCMSComponent

CHILDREN, CMSCOMPONENTCHILDRENFORCMSCOMPONENT_MARKMODIFIED, CMSCOMPONENTCHILDRENFORCMSCOMPONENT_SRC_ORDERED, CMSCOMPONENTCHILDRENFORCMSCOMPONENT_TGT_ORDERED, CONTAINER, DEFAULT_INITIAL_ATTRIBUTES, ELEMENTSFORSLOT_MARKMODIFIED, ELEMENTSFORSLOT_SRC_ORDERED, ELEMENTSFORSLOT_TGT_ORDERED, ONLYONERESTRICTIONMUSTAPPLY, PARENTS, RESTRICTED, RESTRICTIONS, RESTRICTIONSFORCOMPONENTS_MARKMODIFIED, RESTRICTIONSFORCOMPONENTS_SRC_ORDERED, RESTRICTIONSFORCOMPONENTS_TGT_ORDERED, SLOTS, STYLECLASSES, TYPE, TYPECODE, VISIBLE

Fields inherited from class de.hybris.platform.cms2.jalo.contents.GeneratedCMSItem

CATALOGVERSION, NAME, SYNCHRONIZATIONBLOCKED, UID

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

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor	Description
AbstractCMSComponent()

Method Summary

Modifier and Type	Method	Description
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)	Deprecated. since 4.3.
Map<Language,String>	getAllType(SessionContext ctx)	Deprecated. since 4.3.
String	getType(SessionContext ctx)	Deprecated. since 4.3.
String	getTypeCode(SessionContext ctx)	Deprecated. since 4.3.
Boolean	isRestricted(SessionContext ctx)	Deprecated. since 4.3.
Boolean	isVisible(SessionContext ctx)	Deprecated. since 4.3.

Methods inherited from class de.hybris.platform.cms2.jalo.contents.components.GeneratedAbstractCMSComponent

addToChildren, addToChildren, addToParents, addToParents, addToRestrictions, addToRestrictions, addToSlots, addToSlots, getAllType, getChildren, getChildren, getChildrenCount, getChildrenCount, getDefaultAttributeModes, getParents, getParents, getParentsCount, getParentsCount, getRestrictions, getRestrictions, getRestrictionsCount, getRestrictionsCount, getSlots, getSlots, getSlotsCount, getSlotsCount, getStyleClasses, getStyleClasses, getType, getTypeCode, isContainer, isContainer, isContainerAsPrimitive, isContainerAsPrimitive, isMarkModifiedDisabled, isOnlyOneRestrictionMustApply, isOnlyOneRestrictionMustApply, isOnlyOneRestrictionMustApplyAsPrimitive, isOnlyOneRestrictionMustApplyAsPrimitive, isRestricted, isRestrictedAsPrimitive, isRestrictedAsPrimitive, isVisible, isVisibleAsPrimitive, isVisibleAsPrimitive, removeFromChildren, removeFromChildren, removeFromParents, removeFromParents, removeFromRestrictions, removeFromRestrictions, removeFromSlots, removeFromSlots, setChildren, setChildren, setOnlyOneRestrictionMustApply, setOnlyOneRestrictionMustApply, setOnlyOneRestrictionMustApply, setOnlyOneRestrictionMustApply, setParents, setParents, setRestrictions, setRestrictions, setSlots, setSlots, setStyleClasses, setStyleClasses, setVisible, setVisible, setVisible, setVisible

Methods inherited from class de.hybris.platform.cms2.jalo.contents.CMSItem

getName

Methods inherited from class de.hybris.platform.cms2.jalo.contents.GeneratedCMSItem

getCatalogVersion, getCatalogVersion, getName, getUid, getUid, isSynchronizationBlocked, isSynchronizationBlocked, isSynchronizationBlockedAsPrimitive, isSynchronizationBlockedAsPrimitive, setCatalogVersion, setCatalogVersion, setName, setName, setSynchronizationBlocked, setSynchronizationBlocked, setSynchronizationBlocked, setSynchronizationBlocked, setUid, setUid

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

Constructor Details

AbstractCMSComponent

public AbstractCMSComponent()

Method Details

createItem

@Deprecated(since="4.3")
protected Item createItem(SessionContext ctx,
 ComposedType type,
 Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Deprecated.

since 4.3. setAttributeMode is no more needed in slayer.

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 CMSItem

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

getType

@Deprecated(since="4.3")
public String getType(SessionContext ctx)

Deprecated.

since 4.3. Please, use TypeService.getComposedTypeForCode(String) with model.getItemtype() as parameter and then TypeManagerManagedModel.getName() on returned object.

Description copied from class: GeneratedAbstractCMSComponent

Generated method - Getter of the AbstractCMSComponent.type attribute.

Specified by:

getType in class GeneratedAbstractCMSComponent

Returns:

the type

getAllType

@Deprecated(since="4.3")
public Map<Language,String> getAllType(SessionContext ctx)

Deprecated.

since 4.3. Please, use TypeService.getComposedTypeForCode(String) with model.getItemtype() as parameter and then TypeManagerManagedModel.getName() on returned object. For obtaining names for other languages you have to change current locale with I18NService.setCurrentLocale(java.util.Locale).

Description copied from class: GeneratedAbstractCMSComponent

Generated method - Getter of the AbstractCMSComponent.type attribute.

Specified by:

getAllType in class GeneratedAbstractCMSComponent

Returns:

the localized type

getTypeCode

@Deprecated(since="4.3")
public String getTypeCode(SessionContext ctx)

Deprecated.

since 4.3. Please, use AbstractItemModel.getItemtype() or AbstractCMSComponentModel._TYPECODE instead.

Description copied from class: GeneratedAbstractCMSComponent

Generated method - Getter of the AbstractCMSComponent.typeCode attribute.

Specified by:

getTypeCode in class GeneratedAbstractCMSComponent

Returns:

the typeCode

isRestricted

@Deprecated(since="4.3")
public Boolean isRestricted(SessionContext ctx)

Deprecated.

since 4.3. Please, use de.hybris.platform.cms2.servicelayer.services.CMSComponentService#isCmsComponentRestricted(de.hybris.platform.cms2.model.contents.components.AbstractCMSComponentModel) instead.

Description copied from class: GeneratedAbstractCMSComponent

Generated method - Getter of the AbstractCMSComponent.restricted attribute.

Specified by:

isRestricted in class GeneratedAbstractCMSComponent

Returns:

the restricted

isVisible

@Deprecated(since="4.3")
public Boolean isVisible(SessionContext ctx)

Deprecated.

since 4.3. This overriden method is deprecated. Currently Boolean.TRUE value is used as default in cms2-items.xml.

Description copied from class: GeneratedAbstractCMSComponent

Generated method - Getter of the AbstractCMSComponent.visible attribute.

Overrides:

isVisible in class GeneratedAbstractCMSComponent

Returns:

the visible