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

Class AbstractCMSComponentModel

java.lang.Object
de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.core.model.ItemModel
de.hybris.platform.cms2.model.contents.CMSItemModel
de.hybris.platform.cms2.model.contents.components.AbstractCMSComponentModel
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AbstractCMSComponentContainerModel, SimpleCMSComponentModel
public class AbstractCMSComponentModel extends CMSItemModel
Generated model class for type AbstractCMSComponent first defined at extension cms2.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

    de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    _CMSCOMPONENTCHILDRENFORCMSCOMPONENT
    Generated relation code constant for relation CMSComponentChildrenForCMSComponent defining source attribute parents in extension cms2.
    static final String
    _ELEMENTSFORSLOT
    Generated relation code constant for relation ElementsForSlot defining source attribute slots in extension cms2.
    static final String
    _TYPECODE
    Generated model type code constant.
    static final String
    ACTIONS
    Generated constant - Attribute key of AbstractCMSComponent.actions attribute defined at extension acceleratorcms.
    static final String
    CHILDREN
    Generated constant - Attribute key of AbstractCMSComponent.children attribute defined at extension cms2.
    static final String
    CONTAINER
    Generated constant - Attribute key of AbstractCMSComponent.container attribute defined at extension cms2.
    static final String
    ONLYONERESTRICTIONMUSTAPPLY
    Generated constant - Attribute key of AbstractCMSComponent.onlyOneRestrictionMustApply attribute defined at extension cms2.
    static final String
    PARENTS
    Generated constant - Attribute key of AbstractCMSComponent.parents attribute defined at extension cms2.
    static final String
    RESTRICTED
    Generated constant - Attribute key of AbstractCMSComponent.restricted attribute defined at extension cms2.
    static final String
    RESTRICTIONS
    Generated constant - Attribute key of AbstractCMSComponent.restrictions attribute defined at extension cms2.
    static final String
    SLOTS
    Generated constant - Attribute key of AbstractCMSComponent.slots attribute defined at extension cms2.
    static final String
    STYLECLASSES
    Generated constant - Attribute key of AbstractCMSComponent.styleClasses attribute defined at extension cms2.
    static final String
    TYPE
    Generated constant - Attribute key of AbstractCMSComponent.type attribute defined at extension cms2.
    static final String
    TYPECODE
    Generated constant - Attribute key of AbstractCMSComponent.typeCode attribute defined at extension cms2.
    static final String
    VISIBLE
    Generated constant - Attribute key of AbstractCMSComponent.visible attribute defined at extension cms2.

    Fields inherited from class de.hybris.platform.cms2.model.contents.CMSItemModel

    CATALOGVERSION, NAME, SYNCHRONIZATIONBLOCKED, UID

    Fields inherited from class de.hybris.platform.core.model.ItemModel

    _COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALED

    Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

    LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractCMSComponentModel()
    Generated constructor - Default constructor for generic creation.
    AbstractCMSComponentModel(CatalogVersionModel _catalogVersion, ItemModel _owner, String _uid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 4.1.1 Please use the default constructor without parameters
    AbstractCMSComponentModel(CatalogVersionModel _catalogVersion, String _uid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 4.1.1 Please use the default constructor without parameters
    AbstractCMSComponentModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
    Generated constructor - Default constructor for creation with existing context

  • Method Summary

    Modifier and Type
    Method
    Description
    List<AbstractCMSActionModel>
    getActions()
    Generated method - Getter of the AbstractCMSComponent.actions attribute defined at extension acceleratorcms.
    List<AbstractCMSComponentModel>
    getChildren()
    Generated method - Getter of the AbstractCMSComponent.children attribute defined at extension cms2.
    List<AbstractCMSComponentModel>
    getParents()
    Generated method - Getter of the AbstractCMSComponent.parents attribute defined at extension cms2.
    List<AbstractRestrictionModel>
    getRestrictions()
    Generated method - Getter of the AbstractCMSComponent.restrictions attribute defined at extension cms2.
    Collection<ContentSlotModel>
    getSlots()
    Generated method - Getter of the AbstractCMSComponent.slots attribute defined at extension cms2.
    String
    getStyleClasses()
    Generated method - Getter of the AbstractCMSComponent.styleClasses attribute defined at extension cms2.
    String
    getType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 4.3
    String
    getType(Locale loc)
    Deprecated, for removal: This API element is subject to removal in a future version.
    String
    getTypeCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 4.3
    Boolean
    getVisible()
    Generated method - Getter of the AbstractCMSComponent.visible attribute defined at extension cms2.
    boolean
    isContainer()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 4.3
    boolean
    isOnlyOneRestrictionMustApply()
    Generated method - Getter of the AbstractCMSComponent.onlyOneRestrictionMustApply attribute defined at extension cms2.
    boolean
    isRestricted()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 4.3
    void
    setActions(List<AbstractCMSActionModel> value)
    Generated method - Setter of AbstractCMSComponent.actions attribute defined at extension acceleratorcms.
    void
    setChildren(List<AbstractCMSComponentModel> value)
    Generated method - Setter of AbstractCMSComponent.children attribute defined at extension cms2.
    void
    setOnlyOneRestrictionMustApply(boolean value)
    Generated method - Setter of AbstractCMSComponent.onlyOneRestrictionMustApply attribute defined at extension cms2.
    void
    setParents(List<AbstractCMSComponentModel> value)
    Generated method - Setter of AbstractCMSComponent.parents attribute defined at extension cms2.
    void
    setRestrictions(List<AbstractRestrictionModel> value)
    Generated method - Setter of AbstractCMSComponent.restrictions attribute defined at extension cms2.
    void
    setSlots(Collection<ContentSlotModel> value)
    Generated method - Setter of AbstractCMSComponent.slots attribute defined at extension cms2.
    void
    setStyleClasses(String value)
    Generated method - Setter of AbstractCMSComponent.styleClasses attribute defined at extension cms2.
    void
    setVisible(Boolean value)
    Generated method - Setter of AbstractCMSComponent.visible attribute defined at extension cms2.

    Methods inherited from class de.hybris.platform.cms2.model.contents.CMSItemModel

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

    Methods inherited from class de.hybris.platform.core.model.ItemModel

    getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwner

    Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

    equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:

    • _ELEMENTSFORSLOT

      public static final String _ELEMENTSFORSLOT
      Generated relation code constant for relation ElementsForSlot defining source attribute slots in extension cms2.
      See Also:

    • _CMSCOMPONENTCHILDRENFORCMSCOMPONENT

      public static final String _CMSCOMPONENTCHILDRENFORCMSCOMPONENT
      Generated relation code constant for relation CMSComponentChildrenForCMSComponent defining source attribute parents in extension cms2.
      See Also:

    • VISIBLE

      public static final String VISIBLE
      Generated constant - Attribute key of AbstractCMSComponent.visible attribute defined at extension cms2.
      See Also:

    • ONLYONERESTRICTIONMUSTAPPLY

      public static final String ONLYONERESTRICTIONMUSTAPPLY
      Generated constant - Attribute key of AbstractCMSComponent.onlyOneRestrictionMustApply attribute defined at extension cms2.
      See Also:

    • STYLECLASSES

      public static final String STYLECLASSES
      Generated constant - Attribute key of AbstractCMSComponent.styleClasses attribute defined at extension cms2.
      See Also:

    • TYPE

      public static final String TYPE
      Generated constant - Attribute key of AbstractCMSComponent.type attribute defined at extension cms2.
      See Also:

    • TYPECODE

      public static final String TYPECODE
      Generated constant - Attribute key of AbstractCMSComponent.typeCode attribute defined at extension cms2.
      See Also:

    • CONTAINER

      public static final String CONTAINER
      Generated constant - Attribute key of AbstractCMSComponent.container attribute defined at extension cms2.
      See Also:

    • RESTRICTED

      public static final String RESTRICTED
      Generated constant - Attribute key of AbstractCMSComponent.restricted attribute defined at extension cms2.
      See Also:

    • SLOTS

      public static final String SLOTS
      Generated constant - Attribute key of AbstractCMSComponent.slots attribute defined at extension cms2.
      See Also:

    • PARENTS

      public static final String PARENTS
      Generated constant - Attribute key of AbstractCMSComponent.parents attribute defined at extension cms2.
      See Also:

    • CHILDREN

      public static final String CHILDREN
      Generated constant - Attribute key of AbstractCMSComponent.children attribute defined at extension cms2.
      See Also:

    • RESTRICTIONS

      public static final String RESTRICTIONS
      Generated constant - Attribute key of AbstractCMSComponent.restrictions attribute defined at extension cms2.
      See Also:

    • ACTIONS

      public static final String ACTIONS
      Generated constant - Attribute key of AbstractCMSComponent.actions attribute defined at extension acceleratorcms.
      See Also:

  • Constructor Details

    • AbstractCMSComponentModel

      public AbstractCMSComponentModel()
      Generated constructor - Default constructor for generic creation.

    • AbstractCMSComponentModel

      public AbstractCMSComponentModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      Parameters:
      ctx - the model context to be injected, must not be null

    • AbstractCMSComponentModel

      @Deprecated(since="4.1.1", forRemoval=true) public AbstractCMSComponentModel(CatalogVersionModel _catalogVersion, String _uid)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      Generated constructor - Constructor with all mandatory attributes.
      Parameters:
      _catalogVersion - initial attribute declared by type CMSItem at extension cms2
      _uid - initial attribute declared by type CMSItem at extension cms2

    • AbstractCMSComponentModel

      @Deprecated(since="4.1.1", forRemoval=true) public AbstractCMSComponentModel(CatalogVersionModel _catalogVersion, ItemModel _owner, String _uid)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      Generated constructor - for all mandatory and initial attributes.
      Parameters:
      _catalogVersion - initial attribute declared by type CMSItem at extension cms2
      _owner - initial attribute declared by type Item at extension core
      _uid - initial attribute declared by type CMSItem at extension cms2

  • Method Details

    • getActions

      @Accessor(qualifier="actions", type=GETTER) public List<AbstractCMSActionModel> getActions()
      Generated method - Getter of the AbstractCMSComponent.actions attribute defined at extension acceleratorcms. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the actions

    • getChildren

      @Accessor(qualifier="children", type=GETTER) public List<AbstractCMSComponentModel> getChildren()
      Generated method - Getter of the AbstractCMSComponent.children attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the children

    • getParents

      @Accessor(qualifier="parents", type=GETTER) public List<AbstractCMSComponentModel> getParents()
      Generated method - Getter of the AbstractCMSComponent.parents attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the parents

    • getRestrictions

      @Accessor(qualifier="restrictions", type=GETTER) public List<AbstractRestrictionModel> getRestrictions()
      Generated method - Getter of the AbstractCMSComponent.restrictions attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the restrictions

    • getSlots

      @Accessor(qualifier="slots", type=GETTER) public Collection<ContentSlotModel> getSlots()
      Generated method - Getter of the AbstractCMSComponent.slots attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the slots

    • getStyleClasses

      @Accessor(qualifier="styleClasses", type=GETTER) public String getStyleClasses()
      Generated method - Getter of the AbstractCMSComponent.styleClasses attribute defined at extension cms2.
      Returns:
      the styleClasses

    • getType

      @Deprecated(since="4.3", forRemoval=true) @Accessor(qualifier="type", type=GETTER) public String getType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.3
      Generated method - Getter of the AbstractCMSComponent.type attribute defined at extension cms2.
      Returns:
      the type

    • getType

      @Deprecated(since="4.3", forRemoval=true) @Accessor(qualifier="type", type=GETTER) public String getType(Locale loc)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Generated method - Getter of the AbstractCMSComponent.type attribute defined at extension cms2.
      Parameters:
      loc - the value localization key
      Returns:
      the type
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language

    • getTypeCode

      @Deprecated(since="4.3", forRemoval=true) @Accessor(qualifier="typeCode", type=GETTER) public String getTypeCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.3
      Generated method - Getter of the AbstractCMSComponent.typeCode attribute defined at extension cms2.
      Returns:
      the typeCode

    • getVisible

      @Accessor(qualifier="visible", type=GETTER) public Boolean getVisible()
      Generated method - Getter of the AbstractCMSComponent.visible attribute defined at extension cms2.
      Returns:
      the visible

    • isContainer

      @Deprecated(since="4.3", forRemoval=true) @Accessor(qualifier="container", type=GETTER) public boolean isContainer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.3
      Generated method - Getter of the AbstractCMSComponent.container attribute defined at extension cms2.
      Returns:
      the container

    • isOnlyOneRestrictionMustApply

      @Accessor(qualifier="onlyOneRestrictionMustApply", type=GETTER) public boolean isOnlyOneRestrictionMustApply()
      Generated method - Getter of the AbstractCMSComponent.onlyOneRestrictionMustApply attribute defined at extension cms2.
      Returns:
      the onlyOneRestrictionMustApply

    • isRestricted

      @Deprecated(since="4.3", forRemoval=true) @Accessor(qualifier="restricted", type=GETTER) public boolean isRestricted()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.3
      Generated method - Getter of the AbstractCMSComponent.restricted attribute defined at extension cms2.
      Returns:
      the restricted

    • setActions

      @Accessor(qualifier="actions", type=SETTER) public void setActions(List<AbstractCMSActionModel> value)
      Generated method - Setter of AbstractCMSComponent.actions attribute defined at extension acceleratorcms.
      Parameters:
      value - the actions

    • setChildren

      @Accessor(qualifier="children", type=SETTER) public void setChildren(List<AbstractCMSComponentModel> value)
      Generated method - Setter of AbstractCMSComponent.children attribute defined at extension cms2.
      Parameters:
      value - the children

    • setOnlyOneRestrictionMustApply

      @Accessor(qualifier="onlyOneRestrictionMustApply", type=SETTER) public void setOnlyOneRestrictionMustApply(boolean value)
      Generated method - Setter of AbstractCMSComponent.onlyOneRestrictionMustApply attribute defined at extension cms2.
      Parameters:
      value - the onlyOneRestrictionMustApply

    • setParents

      @Accessor(qualifier="parents", type=SETTER) public void setParents(List<AbstractCMSComponentModel> value)
      Generated method - Setter of AbstractCMSComponent.parents attribute defined at extension cms2.
      Parameters:
      value - the parents

    • setRestrictions

      @Accessor(qualifier="restrictions", type=SETTER) public void setRestrictions(List<AbstractRestrictionModel> value)
      Generated method - Setter of AbstractCMSComponent.restrictions attribute defined at extension cms2.
      Parameters:
      value - the restrictions

    • setSlots

      @Accessor(qualifier="slots", type=SETTER) public void setSlots(Collection<ContentSlotModel> value)
      Generated method - Setter of AbstractCMSComponent.slots attribute defined at extension cms2.
      Parameters:
      value - the slots

    • setStyleClasses

      @Accessor(qualifier="styleClasses", type=SETTER) public void setStyleClasses(String value)
      Generated method - Setter of AbstractCMSComponent.styleClasses attribute defined at extension cms2.
      Parameters:
      value - the styleClasses

    • setVisible

      @Accessor(qualifier="visible", type=SETTER) public void setVisible(Boolean value)
      Generated method - Setter of AbstractCMSComponent.visible attribute defined at extension cms2.
      Parameters:
      value - the visible