Package de.hybris.platform.cms2.model.pages

Class AbstractPageModel

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _ABSTRACTPAGE2USERRELATION
      Generated relation code constant for relation AbstractPage2UserRelation defining source attribute lockedBy in extension cms2.
      static java.lang.String _LOCALIZEDPAGERELATION
      Generated relation code constant for relation LocalizedPageRelation defining source attribute originalPage in extension cms2.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String APPROVALSTATUS
      Generated constant - Attribute key of AbstractPage.approvalStatus attribute defined at extension cms2.
      static java.lang.String AVAILABLECONTENTSLOTS
      Generated constant - Attribute key of AbstractPage.availableContentSlots attribute defined at extension cms2.
      static java.lang.String CONTENTSLOTS
      Generated constant - Attribute key of AbstractPage.contentSlots attribute defined at extension cms2.
      static java.lang.String COPYTOCATALOGSDISABLED
      Generated constant - Attribute key of AbstractPage.copyToCatalogsDisabled attribute defined at extension cms2.
      static java.lang.String DEFAULTPAGE
      Generated constant - Attribute key of AbstractPage.defaultPage attribute defined at extension cms2.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of AbstractPage.description attribute defined at extension cms2.
      static java.lang.String DISPLAYSTATUS
      Generated constant - Attribute key of AbstractPage.displayStatus attribute defined at extension cms2.
      static java.lang.String LOCALIZEDPAGES
      Generated constant - Attribute key of AbstractPage.localizedPages attribute defined at extension cms2.
      static java.lang.String LOCKEDBY
      Generated constant - Attribute key of AbstractPage.lockedBy attribute defined at extension cms2.
      static java.lang.String MASTERTEMPLATE
      Generated constant - Attribute key of AbstractPage.masterTemplate attribute defined at extension cms2.
      static java.lang.String MISSINGCONTENTSLOTS
      Generated constant - Attribute key of AbstractPage.missingContentSlots attribute defined at extension cms2.
      static java.lang.String NAVIGATIONNODELIST
      Generated constant - Attribute key of AbstractPage.navigationNodeList attribute defined at extension cms2.
      static java.lang.String ONLYONERESTRICTIONMUSTAPPLY
      Generated constant - Attribute key of AbstractPage.onlyOneRestrictionMustApply attribute defined at extension cms2.
      static java.lang.String ORIGINALPAGE
      Generated constant - Attribute key of AbstractPage.originalPage attribute defined at extension cms2.
      static java.lang.String PAGESTATUS
      Generated constant - Attribute key of AbstractPage.pageStatus attribute defined at extension cms2.
      static java.lang.String PREVIEWIMAGE
      Generated constant - Attribute key of AbstractPage.previewImage attribute defined at extension cms2.
      static java.lang.String RESTRICTIONS
      Generated constant - Attribute key of AbstractPage.restrictions attribute defined at extension cms2.
      static java.lang.String ROBOTTAG
      Generated constant - Attribute key of AbstractPage.robotTag attribute defined at extension cms2.
      static java.lang.String TITLE
      Generated constant - Attribute key of AbstractPage.title attribute defined at extension cms2.
      static java.lang.String TYPE
      Generated constant - Attribute key of AbstractPage.type attribute defined at extension cms2.
      static java.lang.String TYPECODE
      Generated constant - Attribute key of AbstractPage.typeCode attribute defined at extension cms2.
      static java.lang.String VIEW
      Generated constant - Attribute key of AbstractPage.view attribute defined at extension cms2.

    • Field Detail

      • _TYPECODE

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

      • _ABSTRACTPAGE2USERRELATION

        public static final java.lang.String _ABSTRACTPAGE2USERRELATION
        Generated relation code constant for relation AbstractPage2UserRelation defining source attribute lockedBy in extension cms2.
        See Also:
        Constant Field Values

      • _LOCALIZEDPAGERELATION

        public static final java.lang.String _LOCALIZEDPAGERELATION
        Generated relation code constant for relation LocalizedPageRelation defining source attribute originalPage in extension cms2.
        See Also:
        Constant Field Values

      • APPROVALSTATUS

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

      • DISPLAYSTATUS

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

      • PAGESTATUS

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

      • TITLE

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

      • DESCRIPTION

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

      • MASTERTEMPLATE

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

      • DEFAULTPAGE

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

      • ONLYONERESTRICTIONMUSTAPPLY

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

      • PREVIEWIMAGE

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

      • CONTENTSLOTS

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

      • TYPE

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

      • TYPECODE

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

      • MISSINGCONTENTSLOTS

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

      • AVAILABLECONTENTSLOTS

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

      • VIEW

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

      • NAVIGATIONNODELIST

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

      • COPYTOCATALOGSDISABLED

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

      • ROBOTTAG

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

      • RESTRICTIONS

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

      • LOCKEDBY

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

      • ORIGINALPAGE

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

      • LOCALIZEDPAGES

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

    • Constructor Detail

      • AbstractPageModel

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

      • AbstractPageModel

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

      • AbstractPageModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public AbstractPageModel​(CatalogVersionModel _catalogVersion,
                         PageTemplateModel _masterTemplate,
                         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
        _masterTemplate - initial attribute declared by type AbstractPage at extension cms2
        _uid - initial attribute declared by type CMSItem at extension cms2

      • AbstractPageModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public AbstractPageModel​(CatalogVersionModel _catalogVersion,
                         PageTemplateModel _masterTemplate,
                         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
        _masterTemplate - initial attribute declared by type AbstractPage 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

      • getApprovalStatus

        @Accessor(qualifier="approvalStatus",
          type=GETTER)
public CmsApprovalStatus getApprovalStatus()
        Generated method - Getter of the AbstractPage.approvalStatus attribute defined at extension cms2.
        Returns:
        the approvalStatus

      • getAvailableContentSlots

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

      • getContentSlots

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

      • getDefaultPage

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

      • getDescription

        @Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription()
        Generated method - Getter of the AbstractPage.description attribute defined at extension cms2.
        Returns:
        the description - Localized page description.

      • getDescription

        @Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription​(java.util.Locale loc)
        Generated method - Getter of the AbstractPage.description attribute defined at extension cms2.
        Parameters:
        loc - the value localization key
        Returns:
        the description - Localized page description.
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getDisplayStatus

        @Accessor(qualifier="displayStatus",
          type=GETTER)
public CmsItemDisplayStatus getDisplayStatus()
        Generated method - Getter of the AbstractPage.displayStatus dynamic attribute defined at extension cms2.
        Returns:
        the displayStatus

      • getLocalizedPages

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

      • getLockedBy

        @Accessor(qualifier="lockedBy",
          type=GETTER)
public UserModel getLockedBy()
        Generated method - Getter of the AbstractPage.lockedBy attribute defined at extension cms2.
        Returns:
        the lockedBy

      • getMasterTemplate

        @Accessor(qualifier="masterTemplate",
          type=GETTER)
public PageTemplateModel getMasterTemplate()
        Generated method - Getter of the AbstractPage.masterTemplate attribute defined at extension cms2.
        Returns:
        the masterTemplate

      • getMissingContentSlots

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

      • getNavigationNodeList

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

      • getOriginalPage

        @Accessor(qualifier="originalPage",
          type=GETTER)
public AbstractPageModel getOriginalPage()
        Generated method - Getter of the AbstractPage.originalPage attribute defined at extension cms2.
        Returns:
        the originalPage

      • getPageStatus

        @Accessor(qualifier="pageStatus",
          type=GETTER)
public CmsPageStatus getPageStatus()
        Generated method - Getter of the AbstractPage.pageStatus attribute defined at extension cms2.
        Returns:
        the pageStatus

      • getPreviewImage

        @Accessor(qualifier="previewImage",
          type=GETTER)
public MediaModel getPreviewImage()
        Generated method - Getter of the AbstractPage.previewImage attribute defined at extension cms2.
        Returns:
        the previewImage

      • getRestrictions

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

      • getRobotTag

        @Accessor(qualifier="robotTag",
          type=GETTER)
public CmsRobotTag getRobotTag()
        Generated method - Getter of the AbstractPage.robotTag attribute defined at extension cms2.
        Returns:
        the robotTag - Options for indexing and following any links on the page.

      • getTitle

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

      • getTitle

        @Accessor(qualifier="title",
          type=GETTER)
public java.lang.String getTitle​(java.util.Locale loc)
        Generated method - Getter of the AbstractPage.title attribute defined at extension cms2.
        Parameters:
        loc - the value localization key
        Returns:
        the title
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • 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 AbstractPage.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 AbstractPage.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 AbstractPage.typeCode attribute defined at extension cms2.
        Returns:
        the typeCode

      • getView

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

      • isCopyToCatalogsDisabled

        @Accessor(qualifier="copyToCatalogsDisabled",
          type=GETTER)
public boolean isCopyToCatalogsDisabled()
        Generated method - Getter of the AbstractPage.copyToCatalogsDisabled attribute defined at extension cms2.
        Returns:
        the copyToCatalogsDisabled - Determines whether a local version of the page can be copied to another content catalog.

      • isOnlyOneRestrictionMustApply

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

      • setApprovalStatus

        @Accessor(qualifier="approvalStatus",
          type=SETTER)
public void setApprovalStatus​(CmsApprovalStatus value)
        Generated method - Setter of AbstractPage.approvalStatus attribute defined at extension cms2.
        Parameters:
        value - the approvalStatus

      • setCopyToCatalogsDisabled

        @Accessor(qualifier="copyToCatalogsDisabled",
          type=SETTER)
public void setCopyToCatalogsDisabled​(boolean value)
        Generated method - Setter of AbstractPage.copyToCatalogsDisabled attribute defined at extension cms2.
        Parameters:
        value - the copyToCatalogsDisabled - Determines whether a local version of the page can be copied to another content catalog.

      • setDefaultPage

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

      • setDescription

        @Accessor(qualifier="description",
          type=SETTER)
public void setDescription​(java.lang.String value)
        Generated method - Setter of AbstractPage.description attribute defined at extension cms2.
        Parameters:
        value - the description - Localized page description.

      • setDescription

        @Accessor(qualifier="description",
          type=SETTER)
public void setDescription​(java.lang.String value,
                           java.util.Locale loc)
        Generated method - Setter of AbstractPage.description attribute defined at extension cms2.
        Parameters:
        value - the description - Localized page description.
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • setLocalizedPages

        @Accessor(qualifier="localizedPages",
          type=SETTER)
public void setLocalizedPages​(java.util.Collection<AbstractPageModel> value)
        Generated method - Setter of AbstractPage.localizedPages attribute defined at extension cms2.
        Parameters:
        value - the localizedPages

      • setLockedBy

        @Accessor(qualifier="lockedBy",
          type=SETTER)
public void setLockedBy​(UserModel value)
        Generated method - Setter of AbstractPage.lockedBy attribute defined at extension cms2.
        Parameters:
        value - the lockedBy

      • setMasterTemplate

        @Accessor(qualifier="masterTemplate",
          type=SETTER)
public void setMasterTemplate​(PageTemplateModel value)
        Generated method - Setter of AbstractPage.masterTemplate attribute defined at extension cms2.
        Parameters:
        value - the masterTemplate

      • setNavigationNodeList

        @Accessor(qualifier="navigationNodeList",
          type=SETTER)
public void setNavigationNodeList​(java.util.List<CMSNavigationNodeModel> value)
        Generated method - Setter of AbstractPage.navigationNodeList dynamic attribute defined at extension cms2.
        Parameters:
        value - the navigationNodeList

      • setOnlyOneRestrictionMustApply

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

      • setOriginalPage

        @Accessor(qualifier="originalPage",
          type=SETTER)
public void setOriginalPage​(AbstractPageModel value)
        Generated method - Setter of AbstractPage.originalPage attribute defined at extension cms2.
        Parameters:
        value - the originalPage

      • setPageStatus

        @Accessor(qualifier="pageStatus",
          type=SETTER)
public void setPageStatus​(CmsPageStatus value)
        Generated method - Setter of AbstractPage.pageStatus attribute defined at extension cms2.
        Parameters:
        value - the pageStatus

      • setPreviewImage

        @Accessor(qualifier="previewImage",
          type=SETTER)
public void setPreviewImage​(MediaModel value)
        Generated method - Setter of AbstractPage.previewImage attribute defined at extension cms2.
        Parameters:
        value - the previewImage

      • setRestrictions

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

      • setRobotTag

        @Accessor(qualifier="robotTag",
          type=SETTER)
public void setRobotTag​(CmsRobotTag value)
        Generated method - Setter of AbstractPage.robotTag attribute defined at extension cms2.
        Parameters:
        value - the robotTag - Options for indexing and following any links on the page.

      • setTitle

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

      • setTitle

        @Accessor(qualifier="title",
          type=SETTER)
public void setTitle​(java.lang.String value,
                     java.util.Locale loc)
        Generated method - Setter of AbstractPage.title attribute defined at extension cms2.
        Parameters:
        value - the title
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language