Class AbstractCMSComponentModel

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • _ELEMENTSFORSLOT

        public static final java.lang.String _ELEMENTSFORSLOT
        Generated relation code constant for relation ElementsForSlot defining source attribute slots in extension cms2.
        See Also:
        Constant Field Values
      • VISIBLE

        public static final java.lang.String VISIBLE
        Generated constant - Attribute key of AbstractCMSComponent.visible attribute defined at extension cms2.
        See Also:
        Constant Field Values
      • ONLYONERESTRICTIONMUSTAPPLY

        public static final java.lang.String ONLYONERESTRICTIONMUSTAPPLY
        Generated constant - Attribute key of AbstractCMSComponent.onlyOneRestrictionMustApply attribute defined at extension cms2.
        See Also:
        Constant Field Values
      • TYPE

        public static final java.lang.String TYPE
        Generated constant - Attribute key of AbstractCMSComponent.type attribute defined at extension cms2.
        See Also:
        Constant Field Values
      • TYPECODE

        public static final java.lang.String TYPECODE
        Generated constant - Attribute key of AbstractCMSComponent.typeCode attribute defined at extension cms2.
        See Also:
        Constant Field Values
      • CONTAINER

        public static final java.lang.String CONTAINER
        Generated constant - Attribute key of AbstractCMSComponent.container attribute defined at extension cms2.
        See Also:
        Constant Field Values
      • RESTRICTED

        public static final java.lang.String RESTRICTED
        Generated constant - Attribute key of AbstractCMSComponent.restricted attribute defined at extension cms2.
        See Also:
        Constant Field Values
      • SLOTS

        public static final java.lang.String SLOTS
        Generated constant - Attribute key of AbstractCMSComponent.slots attribute defined at extension cms2.
        See Also:
        Constant Field Values
      • RESTRICTIONS

        public static final java.lang.String RESTRICTIONS
        Generated constant - Attribute key of AbstractCMSComponent.restrictions attribute defined at extension cms2.
        See Also:
        Constant Field Values
      • ACTIONS

        public static final java.lang.String ACTIONS
        Generated constant - Attribute key of AbstractCMSComponent.actions attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractCMSComponentModel

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

        public AbstractCMSComponentModel​(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,
                                         java.lang.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,
                                         java.lang.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 Detail

      • getActions

        @Accessor(qualifier="actions",
                  type=GETTER)
        public java.util.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
      • getRestrictions

        @Accessor(qualifier="restrictions",
                  type=GETTER)
        public java.util.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 java.util.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
      • getType

        @Deprecated(since="4.3",
                    forRemoval=true)
        @Accessor(qualifier="type",
                  type=GETTER)
        public java.lang.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 java.lang.String getType​(java.util.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:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getTypeCode

        @Deprecated(since="4.3",
                    forRemoval=true)
        @Accessor(qualifier="typeCode",
                  type=GETTER)
        public java.lang.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 java.lang.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​(java.util.List<AbstractCMSActionModel> value)
        Generated method - Setter of AbstractCMSComponent.actions attribute defined at extension acceleratorcms.
        Parameters:
        value - the actions
      • 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
      • setRestrictions

        @Accessor(qualifier="restrictions",
                  type=SETTER)
        public void setRestrictions​(java.util.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​(java.util.Collection<ContentSlotModel> value)
        Generated method - Setter of AbstractCMSComponent.slots attribute defined at extension cms2.
        Parameters:
        value - the slots
      • setVisible

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