org.hippoecm.hst.pagecomposer.jaxrs.api

Interface PageCopyContext

All Superinterfaces:

PageActionContext

public interface PageCopyContext
extends PageActionContext

Page copying context data used in PageCopyEvent.

Method Summary

Modifier and Type	Method and Description
javax.jcr.Node	getNewPageNode()
javax.jcr.Node	getNewSiteMapItemNode()
HstComponentConfiguration	getSourcePage()
javax.jcr.Node	getSourcePageNode()
HstSiteMapItem	getSourceSiteMapItem()
javax.jcr.Node	getSourceSiteMapNode()
Mount	getTargetMount()
HstSiteMapItem	getTargetSiteMapItem() returns the target HstSiteMapItem to which the page copy action is targeted, or null in case the target is a root siteMapItem

Methods inherited from interface org.hippoecm.hst.pagecomposer.jaxrs.api.PageActionContext

getEditingMount, getRequestContext

Method Detail

getSourceSiteMapItem

HstSiteMapItem getSourceSiteMapItem()

Returns:

the HstSiteMapItem belonging to the page that is to be copied. This HstSiteMapItem instance always belongs to the PageActionContext.getEditingMount(). This method never returns null.

getSourceSiteMapNode

javax.jcr.Node getSourceSiteMapNode()

Returns:

the JCR Node belonging getSourceSiteMapItem(). This method never returns null.

getSourcePage

HstComponentConfiguration getSourcePage()

Returns:

the HstComponentConfiguration belonging getSourceSiteMapItem(). This method never returns null.

getSourcePageNode

javax.jcr.Node getSourcePageNode()

Returns:

the JCR Node belonging getSourcePage(). This method never returns null.

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 as PageActionContext.getEditingMount() This method never returns null.

getTargetSiteMapItem

HstSiteMapItem getTargetSiteMapItem()

returns the target HstSiteMapItem to which the page copy action is targeted, or null in case the target is a root siteMapItem

If it is null, it means the page copy will create a root siteMapItem. A root siteMapItem is a HstSiteMapItem that returns null for HstSiteMapItem.getParentItem().

If it returns a non null value, the returned HstSiteMapItem belongs to getTargetMount()

Returns:

the target HstSiteMapItem to which the page copy action is targeted, or null

getNewSiteMapItemNode

javax.jcr.Node getNewSiteMapItemNode()

Returns:

the in session created (but not yet persisted) site map item JCR Node as a result of this copy page action

getNewPageNode

javax.jcr.Node getNewPageNode()

Returns:

the in session created (but not yet persisted) page JCR Node as a result of this copy page action