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

Class AbstractPageModel

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.pages.AbstractPageModel
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CatalogPageModel, CategoryPageModel, ContentPageModel, DefaultCMSPageServiceTest.SomePageModel, DocumentPageModel, ProductConfigOverviewPageModel, ProductConfigPageModel, ProductPageModel, VendorPageModel
public class AbstractPageModel extends CMSItemModel
Generated model class for type AbstractPage first defined at extension cms2.
See Also:

  • Field Details

    • _TYPECODE

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

    • _ABSTRACTPAGE2USERRELATION

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

    • _LOCALIZEDPAGERELATION

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

    • APPROVALSTATUS

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

    • DISPLAYSTATUS

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

    • PAGESTATUS

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

    • TITLE

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

    • DESCRIPTION

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

    • MASTERTEMPLATE

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

    • DEFAULTPAGE

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

    • ONLYONERESTRICTIONMUSTAPPLY

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

    • PREVIEWIMAGE

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

    • CONTENTSLOTS

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

    • TYPE

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

    • TYPECODE

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

    • MISSINGCONTENTSLOTS

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

    • AVAILABLECONTENTSLOTS

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

    • VIEW

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

    • COPYTOCATALOGSDISABLED

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

    • ROBOTTAG

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

    • RESTRICTIONS

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

    • LOCKEDBY

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

    • ORIGINALPAGE

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

    • LOCALIZEDPAGES

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

  • Constructor Details

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

    • 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 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 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 Boolean getDefaultPage()
      Generated method - Getter of the AbstractPage.defaultPage attribute defined at extension cms2.
      Returns:
      the defaultPage

    • getDescription

      @Accessor(qualifier="description", type=GETTER) public 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 String getDescription(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:
      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 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 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 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 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 String getTitle()
      Generated method - Getter of the AbstractPage.title attribute defined at extension cms2.
      Returns:
      the title

    • getTitle

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

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

    • getView

      @Deprecated(since="4.3", forRemoval=true) @Accessor(qualifier="view", type=GETTER) public 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(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(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(String value, 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:
      IllegalArgumentException - if localization key cannot be mapped to data language

    • setLocalizedPages

      @Accessor(qualifier="localizedPages", type=SETTER) public void setLocalizedPages(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(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(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(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(String value, Locale loc)
      Generated method - Setter of AbstractPage.title attribute defined at extension cms2.
      Parameters:
      value - the title
      loc - the value localization key
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language