Interface PageCopyContext
- All Superinterfaces:
PageActionContext
Page copying context data used in
PageCopyEvent
.-
Method Summary
Modifier and TypeMethodDescriptionreturns the targetHstSiteMapItem
to which the page copy action is targeted, ornull
in case the target is aroot siteMapItem
Methods inherited from interface org.hippoecm.hst.pagecomposer.jaxrs.api.PageActionContext
getEditingMount, getRequestContext
-
Method Details
-
getSourceSiteMapItem
HstSiteMapItem getSourceSiteMapItem()- Returns:
- the
HstSiteMapItem
belonging to the page that is to be copied. ThisHstSiteMapItem
instance always belongs to thePageActionContext.getEditingMount()
. This method never returnsnull
.
-
getSourceSiteMapNode
Node getSourceSiteMapNode()- Returns:
- the JCR
Node
belonginggetSourceSiteMapItem()
. This method never returnsnull
.
-
getSourcePage
HstComponentConfiguration getSourcePage()- Returns:
- the
HstComponentConfiguration
belonginggetSourceSiteMapItem()
. This method never returnsnull
.
-
getSourcePageNode
Node getSourcePageNode()- Returns:
- the JCR
Node
belonginggetSourcePage()
. This method never returnsnull
.
-
getTargetMount
Mount getTargetMount()- Returns:
- the
Mount
that to which the page copy action is targeted. If the page copy is within the same channel, this method returns the exact same instance asPageActionContext.getEditingMount()
This method never returnsnull
.
-
getTargetSiteMapItem
HstSiteMapItem getTargetSiteMapItem()returns the target
HstSiteMapItem
to which the page copy action is targeted, ornull
in case the target is aroot siteMapItem
If it is
null
, it means the page copy will create aroot siteMapItem
. Aroot siteMapItem
is aHstSiteMapItem
that returnsnull
forHstSiteMapItem.getParentItem()
.If it returns a non
null
value, the returnedHstSiteMapItem
belongs togetTargetMount()
- Returns:
- the target
HstSiteMapItem
to which the page copy action is targeted, ornull
-
getNewSiteMapItemNode
Node getNewSiteMapItemNode() -
getNewPageNode
Node getNewPageNode()
-