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,DocumentPageModel,ProductPageModel
Generated model class for type AbstractPage 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
FieldsModifier and TypeFieldDescriptionstatic final StringGenerated relation code constant for relationAbstractPage2UserRelationdefining source attributelockedByin extensioncms2.static final StringGenerated relation code constant for relationLocalizedPageRelationdefining source attributeoriginalPagein extensioncms2.static final StringGenerated model type code constant.static final StringGenerated constant - Attribute key ofAbstractPage.approvalStatusattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.availableContentSlotsattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.contentSlotsattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.copyToCatalogsDisabledattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.defaultPageattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.descriptionattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.displayStatusattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.localizedPagesattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.lockedByattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.masterTemplateattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.missingContentSlotsattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.navigationNodeListattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.onlyOneRestrictionMustApplyattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.originalPageattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.pageStatusattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.previewImageattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.restrictionsattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.robotTagattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.titleattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.typeattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.typeCodeattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofAbstractPage.viewattribute defined at extensioncms2.Fields inherited from class de.hybris.platform.cms2.model.contents.CMSItemModel
CATALOGVERSION, NAME, SYNCHRONIZATIONBLOCKED, UIDFields inherited from class de.hybris.platform.core.model.ItemModel
_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALEDFields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY -
Constructor Summary
ConstructorsConstructorDescriptionGenerated constructor - Default constructor for generic creation.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 parametersAbstractPageModel(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 parametersAbstractPageModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx) Generated constructor - Default constructor for creation with existing context -
Method Summary
Modifier and TypeMethodDescriptionGenerated method - Getter of theAbstractPage.approvalStatusattribute defined at extensioncms2.Deprecated, for removal: This API element is subject to removal in a future version.since 4.3Deprecated, for removal: This API element is subject to removal in a future version.since 4.3Generated method - Getter of theAbstractPage.defaultPageattribute defined at extensioncms2.Generated method - Getter of theAbstractPage.descriptionattribute defined at extensioncms2.getDescription(Locale loc) Generated method - Getter of theAbstractPage.descriptionattribute defined at extensioncms2.Generated method - Getter of theAbstractPage.displayStatusdynamic attribute defined at extensioncms2.Generated method - Getter of theAbstractPage.localizedPagesattribute defined at extensioncms2.Generated method - Getter of theAbstractPage.lockedByattribute defined at extensioncms2.Generated method - Getter of theAbstractPage.masterTemplateattribute defined at extensioncms2.Deprecated, for removal: This API element is subject to removal in a future version.since 4.3Generated method - Getter of theAbstractPage.navigationNodeListdynamic attribute defined at extensioncms2.Generated method - Getter of theAbstractPage.originalPageattribute defined at extensioncms2.Generated method - Getter of theAbstractPage.pageStatusattribute defined at extensioncms2.Generated method - Getter of theAbstractPage.previewImageattribute defined at extensioncms2.Generated method - Getter of theAbstractPage.restrictionsattribute defined at extensioncms2.Generated method - Getter of theAbstractPage.robotTagattribute defined at extensioncms2.getTitle()Generated method - Getter of theAbstractPage.titleattribute defined at extensioncms2.Generated method - Getter of theAbstractPage.titleattribute defined at extensioncms2.getType()Deprecated, for removal: This API element is subject to removal in a future version.since 4.3Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.since 4.3getView()Deprecated, for removal: This API element is subject to removal in a future version.since 4.3booleanGenerated method - Getter of theAbstractPage.copyToCatalogsDisabledattribute defined at extensioncms2.booleanGenerated method - Getter of theAbstractPage.onlyOneRestrictionMustApplyattribute defined at extensioncms2.voidGenerated method - Setter ofAbstractPage.approvalStatusattribute defined at extensioncms2.voidsetCopyToCatalogsDisabled(boolean value) Generated method - Setter ofAbstractPage.copyToCatalogsDisabledattribute defined at extensioncms2.voidsetDefaultPage(Boolean value) Generated method - Setter ofAbstractPage.defaultPageattribute defined at extensioncms2.voidsetDescription(String value) Generated method - Setter ofAbstractPage.descriptionattribute defined at extensioncms2.voidsetDescription(String value, Locale loc) Generated method - Setter ofAbstractPage.descriptionattribute defined at extensioncms2.voidGenerated method - Setter ofAbstractPage.localizedPagesattribute defined at extensioncms2.voidsetLockedBy(UserModel value) Generated method - Setter ofAbstractPage.lockedByattribute defined at extensioncms2.voidGenerated method - Setter ofAbstractPage.masterTemplateattribute defined at extensioncms2.voidGenerated method - Setter ofAbstractPage.navigationNodeListdynamic attribute defined at extensioncms2.voidsetOnlyOneRestrictionMustApply(boolean value) Generated method - Setter ofAbstractPage.onlyOneRestrictionMustApplyattribute defined at extensioncms2.voidsetOriginalPage(AbstractPageModel value) Generated method - Setter ofAbstractPage.originalPageattribute defined at extensioncms2.voidsetPageStatus(CmsPageStatus value) Generated method - Setter ofAbstractPage.pageStatusattribute defined at extensioncms2.voidsetPreviewImage(MediaModel value) Generated method - Setter ofAbstractPage.previewImageattribute defined at extensioncms2.voidGenerated method - Setter ofAbstractPage.restrictionsattribute defined at extensioncms2.voidsetRobotTag(CmsRobotTag value) Generated method - Setter ofAbstractPage.robotTagattribute defined at extensioncms2.voidGenerated method - Setter ofAbstractPage.titleattribute defined at extensioncms2.voidGenerated method - Setter ofAbstractPage.titleattribute defined at extensioncms2.Methods inherited from class de.hybris.platform.cms2.model.contents.CMSItemModel
getCatalogVersion, getName, getUid, isSynchronizationBlocked, setCatalogVersion, setName, setSynchronizationBlocked, setUidMethods inherited from class de.hybris.platform.core.model.ItemModel
getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwnerMethods 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
-
Field Details
-
_TYPECODE
Generated model type code constant.- See Also:
-
_ABSTRACTPAGE2USERRELATION
Generated relation code constant for relationAbstractPage2UserRelationdefining source attributelockedByin extensioncms2.- See Also:
-
_LOCALIZEDPAGERELATION
Generated relation code constant for relationLocalizedPageRelationdefining source attributeoriginalPagein extensioncms2.- See Also:
-
APPROVALSTATUS
Generated constant - Attribute key ofAbstractPage.approvalStatusattribute defined at extensioncms2.- See Also:
-
DISPLAYSTATUS
Generated constant - Attribute key ofAbstractPage.displayStatusattribute defined at extensioncms2.- See Also:
-
PAGESTATUS
Generated constant - Attribute key ofAbstractPage.pageStatusattribute defined at extensioncms2.- See Also:
-
TITLE
Generated constant - Attribute key ofAbstractPage.titleattribute defined at extensioncms2.- See Also:
-
DESCRIPTION
Generated constant - Attribute key ofAbstractPage.descriptionattribute defined at extensioncms2.- See Also:
-
MASTERTEMPLATE
Generated constant - Attribute key ofAbstractPage.masterTemplateattribute defined at extensioncms2.- See Also:
-
DEFAULTPAGE
Generated constant - Attribute key ofAbstractPage.defaultPageattribute defined at extensioncms2.- See Also:
-
ONLYONERESTRICTIONMUSTAPPLY
Generated constant - Attribute key ofAbstractPage.onlyOneRestrictionMustApplyattribute defined at extensioncms2.- See Also:
-
PREVIEWIMAGE
Generated constant - Attribute key ofAbstractPage.previewImageattribute defined at extensioncms2.- See Also:
-
CONTENTSLOTS
Generated constant - Attribute key ofAbstractPage.contentSlotsattribute defined at extensioncms2.- See Also:
-
TYPE
Generated constant - Attribute key ofAbstractPage.typeattribute defined at extensioncms2.- See Also:
-
TYPECODE
Generated constant - Attribute key ofAbstractPage.typeCodeattribute defined at extensioncms2.- See Also:
-
MISSINGCONTENTSLOTS
Generated constant - Attribute key ofAbstractPage.missingContentSlotsattribute defined at extensioncms2.- See Also:
-
AVAILABLECONTENTSLOTS
Generated constant - Attribute key ofAbstractPage.availableContentSlotsattribute defined at extensioncms2.- See Also:
-
VIEW
Generated constant - Attribute key ofAbstractPage.viewattribute defined at extensioncms2.- See Also:
-
NAVIGATIONNODELIST
Generated constant - Attribute key ofAbstractPage.navigationNodeListattribute defined at extensioncms2.- See Also:
-
COPYTOCATALOGSDISABLED
Generated constant - Attribute key ofAbstractPage.copyToCatalogsDisabledattribute defined at extensioncms2.- See Also:
-
ROBOTTAG
Generated constant - Attribute key ofAbstractPage.robotTagattribute defined at extensioncms2.- See Also:
-
RESTRICTIONS
Generated constant - Attribute key ofAbstractPage.restrictionsattribute defined at extensioncms2.- See Also:
-
LOCKEDBY
Generated constant - Attribute key ofAbstractPage.lockedByattribute defined at extensioncms2.- See Also:
-
ORIGINALPAGE
Generated constant - Attribute key ofAbstractPage.originalPageattribute defined at extensioncms2.- See Also:
-
LOCALIZEDPAGES
Generated constant - Attribute key ofAbstractPage.localizedPagesattribute defined at extensioncms2.- See Also:
-
-
Constructor Details
-
AbstractPageModel
public AbstractPageModel()Generated constructor - Default constructor for generic creation. -
AbstractPageModel
public AbstractPageModel(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
-
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 parametersGenerated constructor - Constructor with all mandatory attributes.- Parameters:
_catalogVersion- initial attribute declared by typeCMSItemat extensioncms2_masterTemplate- initial attribute declared by typeAbstractPageat extensioncms2_uid- initial attribute declared by typeCMSItemat extensioncms2
-
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 parametersGenerated constructor - for all mandatory and initial attributes.- Parameters:
_catalogVersion- initial attribute declared by typeCMSItemat extensioncms2_masterTemplate- initial attribute declared by typeAbstractPageat extensioncms2_owner- initial attribute declared by typeItemat extensioncore_uid- initial attribute declared by typeCMSItemat extensioncms2
-
-
Method Details
-
getApprovalStatus
Generated method - Getter of theAbstractPage.approvalStatusattribute defined at extensioncms2.- 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.3Generated method - Getter of theAbstractPage.availableContentSlotsattribute defined at extensioncms2.- 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.3Generated method - Getter of theAbstractPage.contentSlotsattribute defined at extensioncms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the contentSlots
-
getDefaultPage
Generated method - Getter of theAbstractPage.defaultPageattribute defined at extensioncms2.- Returns:
- the defaultPage
-
getDescription
Generated method - Getter of theAbstractPage.descriptionattribute defined at extensioncms2.- Returns:
- the description - Localized page description.
-
getDescription
Generated method - Getter of theAbstractPage.descriptionattribute defined at extensioncms2.- Parameters:
loc- the value localization key- Returns:
- the description - Localized page description.
- Throws:
IllegalArgumentException- if localization key cannot be mapped to data language
-
getDisplayStatus
Generated method - Getter of theAbstractPage.displayStatusdynamic attribute defined at extensioncms2.- Returns:
- the displayStatus
-
getLocalizedPages
@Accessor(qualifier="localizedPages", type=GETTER) public Collection<AbstractPageModel> getLocalizedPages()Generated method - Getter of theAbstractPage.localizedPagesattribute defined at extensioncms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the localizedPages
-
getLockedBy
Generated method - Getter of theAbstractPage.lockedByattribute defined at extensioncms2.- Returns:
- the lockedBy
-
getMasterTemplate
Generated method - Getter of theAbstractPage.masterTemplateattribute defined at extensioncms2.- 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.3Generated method - Getter of theAbstractPage.missingContentSlotsattribute defined at extensioncms2.- Returns:
- the missingContentSlots
-
getOriginalPage
Generated method - Getter of theAbstractPage.originalPageattribute defined at extensioncms2.- Returns:
- the originalPage
-
getPageStatus
Generated method - Getter of theAbstractPage.pageStatusattribute defined at extensioncms2.- Returns:
- the pageStatus
-
getPreviewImage
Generated method - Getter of theAbstractPage.previewImageattribute defined at extensioncms2.- Returns:
- the previewImage
-
getRestrictions
@Accessor(qualifier="restrictions", type=GETTER) public List<AbstractRestrictionModel> getRestrictions()Generated method - Getter of theAbstractPage.restrictionsattribute defined at extensioncms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the restrictions
-
getRobotTag
Generated method - Getter of theAbstractPage.robotTagattribute defined at extensioncms2.- Returns:
- the robotTag - Options for indexing and following any links on the page.
-
getTitle
Generated method - Getter of theAbstractPage.titleattribute defined at extensioncms2.- Returns:
- the title
-
getTitle
Generated method - Getter of theAbstractPage.titleattribute defined at extensioncms2.- 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.3Generated method - Getter of theAbstractPage.typeattribute defined at extensioncms2.- 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 theAbstractPage.typeattribute defined at extensioncms2.- 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.3Generated method - Getter of theAbstractPage.typeCodeattribute defined at extensioncms2.- 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.3Generated method - Getter of theAbstractPage.viewattribute defined at extensioncms2.- Returns:
- the view
-
isCopyToCatalogsDisabled
@Accessor(qualifier="copyToCatalogsDisabled", type=GETTER) public boolean isCopyToCatalogsDisabled()Generated method - Getter of theAbstractPage.copyToCatalogsDisabledattribute defined at extensioncms2.- 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 theAbstractPage.onlyOneRestrictionMustApplyattribute defined at extensioncms2.- Returns:
- the onlyOneRestrictionMustApply
-
setApprovalStatus
@Accessor(qualifier="approvalStatus", type=SETTER) public void setApprovalStatus(CmsApprovalStatus value) Generated method - Setter ofAbstractPage.approvalStatusattribute defined at extensioncms2.- Parameters:
value- the approvalStatus
-
setCopyToCatalogsDisabled
@Accessor(qualifier="copyToCatalogsDisabled", type=SETTER) public void setCopyToCatalogsDisabled(boolean value) Generated method - Setter ofAbstractPage.copyToCatalogsDisabledattribute defined at extensioncms2.- Parameters:
value- the copyToCatalogsDisabled - Determines whether a local version of the page can be copied to another content catalog.
-
setDefaultPage
Generated method - Setter ofAbstractPage.defaultPageattribute defined at extensioncms2.- Parameters:
value- the defaultPage
-
setDescription
Generated method - Setter ofAbstractPage.descriptionattribute defined at extensioncms2.- Parameters:
value- the description - Localized page description.
-
setDescription
@Accessor(qualifier="description", type=SETTER) public void setDescription(String value, Locale loc) Generated method - Setter ofAbstractPage.descriptionattribute defined at extensioncms2.- 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 ofAbstractPage.localizedPagesattribute defined at extensioncms2.- Parameters:
value- the localizedPages
-
setLockedBy
Generated method - Setter ofAbstractPage.lockedByattribute defined at extensioncms2.- Parameters:
value- the lockedBy
-
setMasterTemplate
@Accessor(qualifier="masterTemplate", type=SETTER) public void setMasterTemplate(PageTemplateModel value) Generated method - Setter ofAbstractPage.masterTemplateattribute defined at extensioncms2.- Parameters:
value- the masterTemplate
-
setOnlyOneRestrictionMustApply
@Accessor(qualifier="onlyOneRestrictionMustApply", type=SETTER) public void setOnlyOneRestrictionMustApply(boolean value) Generated method - Setter ofAbstractPage.onlyOneRestrictionMustApplyattribute defined at extensioncms2.- Parameters:
value- the onlyOneRestrictionMustApply
-
setOriginalPage
@Accessor(qualifier="originalPage", type=SETTER) public void setOriginalPage(AbstractPageModel value) Generated method - Setter ofAbstractPage.originalPageattribute defined at extensioncms2.- Parameters:
value- the originalPage
-
setPageStatus
Generated method - Setter ofAbstractPage.pageStatusattribute defined at extensioncms2.- Parameters:
value- the pageStatus
-
setPreviewImage
Generated method - Setter ofAbstractPage.previewImageattribute defined at extensioncms2.- Parameters:
value- the previewImage
-
setRestrictions
@Accessor(qualifier="restrictions", type=SETTER) public void setRestrictions(List<AbstractRestrictionModel> value) Generated method - Setter ofAbstractPage.restrictionsattribute defined at extensioncms2.- Parameters:
value- the restrictions
-
setRobotTag
Generated method - Setter ofAbstractPage.robotTagattribute defined at extensioncms2.- Parameters:
value- the robotTag - Options for indexing and following any links on the page.
-
setTitle
Generated method - Setter ofAbstractPage.titleattribute defined at extensioncms2.- Parameters:
value- the title
-
setTitle
Generated method - Setter ofAbstractPage.titleattribute defined at extensioncms2.- Parameters:
value- the titleloc- the value localization key- Throws:
IllegalArgumentException- if localization key cannot be mapped to data language
-