Package de.hybris.platform.cms2.model.site

Class CMSSiteModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class CMSSiteModel
extends BaseSiteModel
    Generated model class for type CMSSite first defined at extension cms2.
    See Also:
    Serialized Form

    • Field Detail

      • _TYPECODE

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

      • URLPATTERNS

        public static final java.lang.String URLPATTERNS
        Generated constant - Attribute key of CMSSite.urlPatterns attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • ACTIVE

        public static final java.lang.String ACTIVE
        Generated constant - Attribute key of CMSSite.active attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • ACTIVEFROM

        public static final java.lang.String ACTIVEFROM
        Generated constant - Attribute key of CMSSite.activeFrom attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • ACTIVEUNTIL

        public static final java.lang.String ACTIVEUNTIL
        Generated constant - Attribute key of CMSSite.activeUntil attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • DEFAULTCATALOG

        public static final java.lang.String DEFAULTCATALOG
        Generated constant - Attribute key of CMSSite.defaultCatalog attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • STARTINGPAGE

        public static final java.lang.String STARTINGPAGE
        Generated constant - Attribute key of CMSSite.startingPage attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • REDIRECTURL

        public static final java.lang.String REDIRECTURL
        Generated constant - Attribute key of CMSSite.redirectURL attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • PREVIEWURL

        public static final java.lang.String PREVIEWURL
        Generated constant - Attribute key of CMSSite.previewURL attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • CLASSIFICATIONCATALOGS

        public static final java.lang.String CLASSIFICATIONCATALOGS
        Generated constant - Attribute key of CMSSite.classificationCatalogs attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • PRODUCTCATALOGS

        public static final java.lang.String PRODUCTCATALOGS
        Generated constant - Attribute key of CMSSite.productCatalogs attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • STARTPAGELABEL

        public static final java.lang.String STARTPAGELABEL
        Generated constant - Attribute key of CMSSite.startPageLabel attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • OPENPREVIEWINNEWTAB

        public static final java.lang.String OPENPREVIEWINNEWTAB
        Generated constant - Attribute key of CMSSite.openPreviewInNewTab attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • DEFAULTPREVIEWCATEGORY

        public static final java.lang.String DEFAULTPREVIEWCATEGORY
        Generated constant - Attribute key of CMSSite.defaultPreviewCategory attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • DEFAULTPREVIEWPRODUCT

        public static final java.lang.String DEFAULTPREVIEWPRODUCT
        Generated constant - Attribute key of CMSSite.defaultPreviewProduct attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • DEFAULTPREVIEWCATALOG

        public static final java.lang.String DEFAULTPREVIEWCATALOG
        Generated constant - Attribute key of CMSSite.defaultPreviewCatalog attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • CONTENTCATALOGS

        public static final java.lang.String CONTENTCATALOGS
        Generated constant - Attribute key of CMSSite.contentCatalogs attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • VALIDCOMPONENTTYPES

        public static final java.lang.String VALIDCOMPONENTTYPES
        Generated constant - Attribute key of CMSSite.validComponentTypes attribute defined at extension cms2.
        See Also:
        Constant Field Values

      • URLENCODINGATTRIBUTES

        public static final java.lang.String URLENCODINGATTRIBUTES
        Generated constant - Attribute key of CMSSite.urlEncodingAttributes attribute defined at extension acceleratorservices.
        See Also:
        Constant Field Values

      • SITEMAPS

        public static final java.lang.String SITEMAPS
        Generated constant - Attribute key of CMSSite.siteMaps attribute defined at extension acceleratorservices.
        See Also:
        Constant Field Values

      • SITEMAPCONFIG

        public static final java.lang.String SITEMAPCONFIG
        Generated constant - Attribute key of CMSSite.siteMapConfig attribute defined at extension acceleratorservices.
        See Also:
        Constant Field Values

      • DEFAULTSTOCKLEVELTHRESHOLD

        public static final java.lang.String DEFAULTSTOCKLEVELTHRESHOLD
        Generated constant - Attribute key of CMSSite.defaultStockLevelThreshold attribute defined at extension b2bacceleratorservices.
        See Also:
        Constant Field Values

      • REQUIRESAUTHENTICATION

        public static final java.lang.String REQUIRESAUTHENTICATION
        Generated constant - Attribute key of CMSSite.requiresAuthentication attribute defined at extension secureportaladdon.
        See Also:
        Constant Field Values

      • ENABLEREGISTRATION

        public static final java.lang.String ENABLEREGISTRATION
        Generated constant - Attribute key of CMSSite.enableRegistration attribute defined at extension secureportaladdon.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CMSSiteModel

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

      • CMSSiteModel

        public CMSSiteModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • CMSSiteModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public CMSSiteModel​(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:
        _uid - initial attribute declared by type BaseSite at extension basecommerce

      • CMSSiteModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public CMSSiteModel​(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:
        _owner - initial attribute declared by type Item at extension core
        _uid - initial attribute declared by type BaseSite at extension basecommerce

    • Method Detail

      • getActive

        @Accessor(qualifier="active",
          type=GETTER)
public java.lang.Boolean getActive()
        Generated method - Getter of the CMSSite.active attribute defined at extension cms2.
        Returns:
        the active

      • getActiveFrom

        @Accessor(qualifier="activeFrom",
          type=GETTER)
public java.util.Date getActiveFrom()
        Generated method - Getter of the CMSSite.activeFrom attribute defined at extension cms2.
        Returns:
        the activeFrom

      • getActiveUntil

        @Accessor(qualifier="activeUntil",
          type=GETTER)
public java.util.Date getActiveUntil()
        Generated method - Getter of the CMSSite.activeUntil attribute defined at extension cms2.
        Returns:
        the activeUntil

      • getClassificationCatalogs

        @Deprecated(since="4.3",
            forRemoval=true)
@Accessor(qualifier="classificationCatalogs",
          type=GETTER)
public java.util.List<CatalogModel> getClassificationCatalogs()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.3
        Generated method - Getter of the CMSSite.classificationCatalogs attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the classificationCatalogs

      • getContentCatalogs

        @Accessor(qualifier="contentCatalogs",
          type=GETTER)
public java.util.List<ContentCatalogModel> getContentCatalogs()
        Generated method - Getter of the CMSSite.contentCatalogs attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the contentCatalogs

      • getDefaultCatalog

        @Accessor(qualifier="defaultCatalog",
          type=GETTER)
public CatalogModel getDefaultCatalog()
        Generated method - Getter of the CMSSite.defaultCatalog attribute defined at extension cms2.
        Returns:
        the defaultCatalog

      • getDefaultPreviewCatalog

        @Accessor(qualifier="defaultPreviewCatalog",
          type=GETTER)
public CatalogModel getDefaultPreviewCatalog()
        Generated method - Getter of the CMSSite.defaultPreviewCatalog attribute defined at extension cms2.
        Returns:
        the defaultPreviewCatalog

      • getDefaultPreviewCategory

        @Accessor(qualifier="defaultPreviewCategory",
          type=GETTER)
public CategoryModel getDefaultPreviewCategory()
        Generated method - Getter of the CMSSite.defaultPreviewCategory attribute defined at extension cms2.
        Returns:
        the defaultPreviewCategory

      • getDefaultPreviewProduct

        @Accessor(qualifier="defaultPreviewProduct",
          type=GETTER)
public ProductModel getDefaultPreviewProduct()
        Generated method - Getter of the CMSSite.defaultPreviewProduct attribute defined at extension cms2.
        Returns:
        the defaultPreviewProduct

      • getDefaultStockLevelThreshold

        @Accessor(qualifier="defaultStockLevelThreshold",
          type=GETTER)
public java.lang.Integer getDefaultStockLevelThreshold()
        Generated method - Getter of the CMSSite.defaultStockLevelThreshold attribute defined at extension b2bacceleratorservices.
        Returns:
        the defaultStockLevelThreshold - Indicates the threshold default value.

      • getPreviewURL

        @Accessor(qualifier="previewURL",
          type=GETTER)
public java.lang.String getPreviewURL()
        Generated method - Getter of the CMSSite.previewURL attribute defined at extension cms2.
        Returns:
        the previewURL

      • getProductCatalogs

        @Deprecated(since="4.3",
            forRemoval=true)
@Accessor(qualifier="productCatalogs",
          type=GETTER)
public java.util.List<CatalogModel> getProductCatalogs()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.3
        Generated method - Getter of the CMSSite.productCatalogs attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the productCatalogs

      • getRedirectURL

        @Accessor(qualifier="redirectURL",
          type=GETTER)
public java.lang.String getRedirectURL()
        Generated method - Getter of the CMSSite.redirectURL attribute defined at extension cms2.
        Returns:
        the redirectURL

      • getSiteMapConfig

        @Accessor(qualifier="siteMapConfig",
          type=GETTER)
public SiteMapConfigModel getSiteMapConfig()
        Generated method - Getter of the CMSSite.siteMapConfig attribute defined at extension acceleratorservices.
        Returns:
        the siteMapConfig

      • getSiteMaps

        @Accessor(qualifier="siteMaps",
          type=GETTER)
public java.util.Collection<MediaModel> getSiteMaps()
        Generated method - Getter of the CMSSite.siteMaps attribute defined at extension acceleratorservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the siteMaps

      • getStartingPage

        @Accessor(qualifier="startingPage",
          type=GETTER)
public ContentPageModel getStartingPage()
        Generated method - Getter of the CMSSite.startingPage attribute defined at extension cms2.
        Returns:
        the startingPage

      • getStartPageLabel

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

      • getUrlEncodingAttributes

        @Accessor(qualifier="urlEncodingAttributes",
          type=GETTER)
public java.util.Collection<java.lang.String> getUrlEncodingAttributes()
        Generated method - Getter of the CMSSite.urlEncodingAttributes attribute defined at extension acceleratorservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the urlEncodingAttributes

      • getUrlPatterns

        @Accessor(qualifier="urlPatterns",
          type=GETTER)
public java.util.Collection<java.lang.String> getUrlPatterns()
        Generated method - Getter of the CMSSite.urlPatterns attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the urlPatterns

      • getValidComponentTypes

        @Accessor(qualifier="validComponentTypes",
          type=GETTER)
public java.util.Set<CMSComponentTypeModel> getValidComponentTypes()
        Generated method - Getter of the CMSSite.validComponentTypes attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the validComponentTypes

      • isEnableRegistration

        @Accessor(qualifier="enableRegistration",
          type=GETTER)
public boolean isEnableRegistration()
        Generated method - Getter of the CMSSite.enableRegistration attribute defined at extension secureportaladdon.
        Returns:
        the enableRegistration - Indicates if the website supports registration request.

      • isOpenPreviewInNewTab

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

      • isRequiresAuthentication

        @Accessor(qualifier="requiresAuthentication",
          type=GETTER)
public boolean isRequiresAuthentication()
        Generated method - Getter of the CMSSite.requiresAuthentication attribute defined at extension secureportaladdon.
        Returns:
        the requiresAuthentication - Indicates if the website requires authentication or not.

      • setActive

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

      • setActiveFrom

        @Accessor(qualifier="activeFrom",
          type=SETTER)
public void setActiveFrom​(java.util.Date value)
        Generated method - Setter of CMSSite.activeFrom attribute defined at extension cms2.
        Parameters:
        value - the activeFrom

      • setActiveUntil

        @Accessor(qualifier="activeUntil",
          type=SETTER)
public void setActiveUntil​(java.util.Date value)
        Generated method - Setter of CMSSite.activeUntil attribute defined at extension cms2.
        Parameters:
        value - the activeUntil

      • setContentCatalogs

        @Accessor(qualifier="contentCatalogs",
          type=SETTER)
public void setContentCatalogs​(java.util.List<ContentCatalogModel> value)
        Generated method - Setter of CMSSite.contentCatalogs attribute defined at extension cms2.
        Parameters:
        value - the contentCatalogs

      • setDefaultCatalog

        @Accessor(qualifier="defaultCatalog",
          type=SETTER)
public void setDefaultCatalog​(CatalogModel value)
        Generated method - Setter of CMSSite.defaultCatalog attribute defined at extension cms2.
        Parameters:
        value - the defaultCatalog

      • setDefaultPreviewCatalog

        @Accessor(qualifier="defaultPreviewCatalog",
          type=SETTER)
public void setDefaultPreviewCatalog​(CatalogModel value)
        Generated method - Setter of CMSSite.defaultPreviewCatalog attribute defined at extension cms2.
        Parameters:
        value - the defaultPreviewCatalog

      • setDefaultPreviewCategory

        @Accessor(qualifier="defaultPreviewCategory",
          type=SETTER)
public void setDefaultPreviewCategory​(CategoryModel value)
        Generated method - Setter of CMSSite.defaultPreviewCategory attribute defined at extension cms2.
        Parameters:
        value - the defaultPreviewCategory

      • setDefaultPreviewProduct

        @Accessor(qualifier="defaultPreviewProduct",
          type=SETTER)
public void setDefaultPreviewProduct​(ProductModel value)
        Generated method - Setter of CMSSite.defaultPreviewProduct attribute defined at extension cms2.
        Parameters:
        value - the defaultPreviewProduct

      • setDefaultStockLevelThreshold

        @Accessor(qualifier="defaultStockLevelThreshold",
          type=SETTER)
public void setDefaultStockLevelThreshold​(java.lang.Integer value)
        Generated method - Setter of CMSSite.defaultStockLevelThreshold attribute defined at extension b2bacceleratorservices.
        Parameters:
        value - the defaultStockLevelThreshold - Indicates the threshold default value.

      • setEnableRegistration

        @Accessor(qualifier="enableRegistration",
          type=SETTER)
public void setEnableRegistration​(boolean value)
        Generated method - Setter of CMSSite.enableRegistration attribute defined at extension secureportaladdon.
        Parameters:
        value - the enableRegistration - Indicates if the website supports registration request.

      • setOpenPreviewInNewTab

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

      • setPreviewURL

        @Accessor(qualifier="previewURL",
          type=SETTER)
public void setPreviewURL​(java.lang.String value)
        Generated method - Setter of CMSSite.previewURL attribute defined at extension cms2.
        Parameters:
        value - the previewURL

      • setRedirectURL

        @Accessor(qualifier="redirectURL",
          type=SETTER)
public void setRedirectURL​(java.lang.String value)
        Generated method - Setter of CMSSite.redirectURL attribute defined at extension cms2.
        Parameters:
        value - the redirectURL

      • setRequiresAuthentication

        @Accessor(qualifier="requiresAuthentication",
          type=SETTER)
public void setRequiresAuthentication​(boolean value)
        Generated method - Setter of CMSSite.requiresAuthentication attribute defined at extension secureportaladdon.
        Parameters:
        value - the requiresAuthentication - Indicates if the website requires authentication or not.

      • setSiteMapConfig

        @Accessor(qualifier="siteMapConfig",
          type=SETTER)
public void setSiteMapConfig​(SiteMapConfigModel value)
        Generated method - Setter of CMSSite.siteMapConfig attribute defined at extension acceleratorservices.
        Parameters:
        value - the siteMapConfig

      • setSiteMaps

        @Accessor(qualifier="siteMaps",
          type=SETTER)
public void setSiteMaps​(java.util.Collection<MediaModel> value)
        Generated method - Setter of CMSSite.siteMaps attribute defined at extension acceleratorservices.
        Parameters:
        value - the siteMaps

      • setStartingPage

        @Accessor(qualifier="startingPage",
          type=SETTER)
public void setStartingPage​(ContentPageModel value)
        Generated method - Setter of CMSSite.startingPage attribute defined at extension cms2.
        Parameters:
        value - the startingPage

      • setUrlEncodingAttributes

        @Accessor(qualifier="urlEncodingAttributes",
          type=SETTER)
public void setUrlEncodingAttributes​(java.util.Collection<java.lang.String> value)
        Generated method - Setter of CMSSite.urlEncodingAttributes attribute defined at extension acceleratorservices.
        Parameters:
        value - the urlEncodingAttributes

      • setUrlPatterns

        @Accessor(qualifier="urlPatterns",
          type=SETTER)
public void setUrlPatterns​(java.util.Collection<java.lang.String> value)
        Generated method - Setter of CMSSite.urlPatterns attribute defined at extension cms2.
        Parameters:
        value - the urlPatterns

      • setValidComponentTypes

        @Accessor(qualifier="validComponentTypes",
          type=SETTER)
public void setValidComponentTypes​(java.util.Set<CMSComponentTypeModel> value)
        Generated method - Setter of CMSSite.validComponentTypes attribute defined at extension cms2.
        Parameters:
        value - the validComponentTypes