oracle.webcenter.portal.api

Interface Page

All Superinterfaces:

BasePage<PagePropertyBean>, ManagedPortalObject<PagePropertyBean>, PortalObject<PagePropertyBean>

public interface Page
extends BasePage<PagePropertyBean>

A Page instance represents a page running within the portal server.

Since:

12.1.4

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.webcenter.portal.api.ManagedPortalObject

ManagedPortalObject.ValidateOnCreate, ManagedPortalObject.ValidateOnUpdate

Method Summary

Modifier and Type	Method and Description
PageStyle	copyAsPageStyle(PageStyle pageStyle, boolean visible) Copies the properties from the Page to the PageStyle.
PageStyle	copyAsPageStyle(java.lang.String name, java.lang.String description, boolean visible) Creates a PageStyle from the Page.
Page	createDraft() Creates a draft
java.lang.String	getAccessURL() Get the access url for the page
Page	getBase() Gets the base page of the draft
Page	getDraft() Gets the draft of the page
NavigationNode	getNavigationNode() Gets the node associated with the page
PageStyle	getPageStyle() Gets the page style the page was created with
boolean	isDraft() Checks if a page is a draft
Page	lockPage() Lock the page and other users cannot edit it in composer
Page	publishDraft() publish the draft
void	setDraft(Page pageDraft) Sets the draft for the page
void	setPageStyle(PageStyle pageStyle) Sets the page style the page was created with
Page	unlockPage() Unlock the page and other users can edit it in composer

Methods inherited from interface oracle.webcenter.portal.api.BasePage

addContentItem, addDPTaskFlow, addPageDefinitionParameter, clearPageDefinitionParameter, getContentById, getContentByType, getContentItems, getDPTaskFlow, getLayout, getPageDefinitionParameters, removeDPTaskFlow, removePageDefinitionParameter, setLayout, setLayout, setPageDefinitionParameters

Methods inherited from interface oracle.webcenter.portal.api.ManagedPortalObject

copy, copy, delete, expandProperties, getAuthorizedActions, getDependentPortalObjects, getHolder, getPortal, getTypeName, isCurrent, isValid, setPortal, setProperties

Methods inherited from interface oracle.webcenter.portal.api.PortalObject

getId, getProperties, getProperties

Method Detail

copyAsPageStyle

PageStyle copyAsPageStyle(java.lang.String name,
                          java.lang.String description,
                          boolean visible)
                   throws DuplicateNameException

Creates a PageStyle from the Page. The properties that both Page and PageStyle have in common are copied from the Page to the PageStyle.

Parameters:

name - the new name for the PageStyle

description - the new description for the PageStyle

visible - whether the page style should be visible

Returns:

the PageStyle

Throws:

DuplicateNameException - thrown if the name has already been used by another page style in the portal

copyAsPageStyle

PageStyle copyAsPageStyle(PageStyle pageStyle,
                          boolean visible)

Copies the properties from the Page to the PageStyle. The properties that both Page and PageStyle have in common are copied from the Page to the PageStyle.

Parameters:

pageStyle - the PageStyle to copy the properties to

visible - whether the page style should be visible

Returns:

the PageStyle

getPageStyle

PageStyle getPageStyle()

Gets the page style the page was created with

Returns:

the page style

setPageStyle

void setPageStyle(PageStyle pageStyle)

Sets the page style the page was created with

Parameters:

pageStyle - the page style

createDraft

Page createDraft()

Creates a draft

Returns:

the draft

setDraft

void setDraft(Page pageDraft)

Sets the draft for the page

Parameters:

pageDraft - the draft page

getDraft

Page getDraft()

Gets the draft of the page

Returns:

the draft page

getBase

Page getBase()

Gets the base page of the draft

Returns:

the base page

publishDraft

Page publishDraft()

publish the draft

Returns:

the new base page

isDraft

boolean isDraft()

Checks if a page is a draft

Returns:

the flag that indicates if the page is a draft

lockPage

Page lockPage()

Lock the page and other users cannot edit it in composer

Returns:

the page with updated properties

unlockPage

Page unlockPage()

Unlock the page and other users can edit it in composer

Returns:

the page with updated properties

getNavigationNode

NavigationNode getNavigationNode()

Gets the node associated with the page

Returns:

the node

getAccessURL

java.lang.String getAccessURL()

Get the access url for the page

Returns:

the access url