oracle.webcenter.portal.api

Class BasePagePropertyBean

java.lang.Object

oracle.webcenter.jaxrs.framework.model.Linked

oracle.webcenter.portal.api.PropertyBean

oracle.webcenter.portal.api.BasePagePropertyBean

All Implemented Interfaces:

oracle.webcenter.jaxrs.framework.model.LinkedInterface

Direct Known Subclasses:

PagePropertyBean, PageStylePropertyBean, PageTemplatePropertyBean

public abstract class BasePagePropertyBean
extends PropertyBean

Properties common to all page-like portal objects.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.webcenter.portal.api.PropertyBean

PropertyBean.SimpleValueHolder<T>

Field Summary

Fields inherited from class oracle.webcenter.jaxrs.framework.model.Linked

links, linkStates, resourceType

Fields inherited from interface oracle.webcenter.jaxrs.framework.model.LinkedInterface

LINK, LINKS

Constructor Summary

Constructors

Constructor and Description
BasePagePropertyBean()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInputFileName() Get the input file name for use in the MDS path of Page View and Page Definition files.
java.io.Reader	getPageDefinitionContent() Get a Reader for the contents of the Page Definition associated with this page.
ValueHolder<java.io.Reader>	getPageDefinitionContentValueHolder() Get the contents of the Page Definition associated with this page as as a ValueHolder.
java.lang.String	getPageDefinitionPath() Get Page Definition file path in MDS.
java.lang.String	getPagePath() Get JSPx file path in MDS.
PageViewType	getPageViewType() Gets the page view type.
java.lang.String	getSourcePageDefinitionPath() Deprecated.
java.lang.String	getSourcePath() Deprecated.
java.io.Reader	getViewDefinitionContent() Get a Reader for the contents of the View Definition associated with this page.
ValueHolder<java.io.Reader>	getViewDefinitionContentValueHolder() Get the contents of the View Definition associated with this page as as a ValueHolder.
abstract java.lang.String	linkPath() Set the link prefix for the underlying class to generate correct REST Links.
void	populateLinks(oracle.webcenter.jaxrs.framework.uri.UriService service) Used By REST API to pass in UriService to create auxiliary links
void	setInputFileName(java.lang.String inputFileName) Set the input file name for use in the MDS path of Page View and Page Definition files.
void	setPageDefinitionContent(java.io.Reader input) Set the contents of the Page Definition associated with this page, as a Reader.
void	setPageDefinitionContentFromString(java.lang.String input) Set the contents of the Page Definition associated with this page, as a String.
void	setPageDefinitionContentValueHolder(ValueHolder<java.io.Reader> input) Set the contents of the Page Definition associated with this page, as a ValueHolder.
void	setPageDefinitionPath(java.lang.String pageDefinitionPath) Set Page Definition file path in MDS.
void	setPagePath(java.lang.String pagePath) Set JSPx file path in MDS.
void	setPageViewType(PageViewType pageViewType) Sets the page view type.
void	setSourcePageDefinitionPath(java.lang.String sourcePageDefinitionPath) Deprecated.
void	setSourcePath(java.lang.String sourcePath) Deprecated.
void	setViewDefinitionContent(java.io.Reader input) Set the contents of the View Definition associated with this page, as a Reader.
void	setViewDefinitionContentFromString(java.lang.String input) Set the contents of the View Definition associated with this page, as a String.
void	setViewDefinitionContentValueHolder(ValueHolder<java.io.Reader> input) Set the contents of the View Definition associated with this page, as a ValueHolder.

Methods inherited from class oracle.webcenter.portal.api.PropertyBean

getCreated, getCreator, getCreatorGuid, getCurrentVersionId, getDescription, getDocumentRef, getId, getLocale, getModified, getModifier, getModifierGuid, getName, getNamespace, getNewVersionId, getPortalShortId, getReference, getSecurityId, getShortId, populateSubLinks, resourceType, setCreated, setCreator, setCurrentVersionId, setDescription, setDocumentRef, setId, setLocale, setModified, setModifier, setName, setNamespace, setNewVersionId, setPortalShortId, setReference, setSecurityId, setShortId

Methods inherited from class oracle.webcenter.jaxrs.framework.model.Linked

addLink, addLinkState, getLinkElement, getLinks, getLinkURI, getResourceType, linkStates, linkStates, setLinks, setResourceType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasePagePropertyBean

public BasePagePropertyBean()

Method Detail

populateLinks

public void populateLinks(oracle.webcenter.jaxrs.framework.uri.UriService service)

Used By REST API to pass in UriService to create auxiliary links

Overrides:

populateLinks in class PropertyBean

Parameters:

service - UriService

linkPath

public abstract java.lang.String linkPath()

Set the link prefix for the underlying class to generate correct REST Links.

setViewDefinitionContentValueHolder

public void setViewDefinitionContentValueHolder(ValueHolder<java.io.Reader> input)

Set the contents of the View Definition associated with this page, as a ValueHolder.

Parameters:

input - A Value Holder holding a Reader for the view definition

getViewDefinitionContentValueHolder

public ValueHolder<java.io.Reader> getViewDefinitionContentValueHolder()

Get the contents of the View Definition associated with this page as as a ValueHolder.

The view definition document will not be fetched from backend storage until getValue() is called on the ValueHolder.

Returns:

A ValueHolder holding a Reader to the view definition contents.

setViewDefinitionContent

public void setViewDefinitionContent(java.io.Reader input)

Set the contents of the View Definition associated with this page, as a Reader.

Parameters:

input - A Reader for the view definition contents.

setViewDefinitionContentFromString

public void setViewDefinitionContentFromString(java.lang.String input)

Set the contents of the View Definition associated with this page, as a String.

Parameters:

input - A String containing the view definition contents.

getViewDefinitionContent

public java.io.Reader getViewDefinitionContent()

Get a Reader for the contents of the View Definition associated with this page.

Returns:

A ValueHolder holding a Reader to the view definition contents.

setPageDefinitionContentValueHolder

public void setPageDefinitionContentValueHolder(ValueHolder<java.io.Reader> input)

Set the contents of the Page Definition associated with this page, as a ValueHolder.

Parameters:

input - A Value Holder holding a Reader for the page definition

getPageDefinitionContentValueHolder

public ValueHolder<java.io.Reader> getPageDefinitionContentValueHolder()

Get the contents of the Page Definition associated with this page as as a ValueHolder.

The page definition document will not be fetched from backend storage until getValue() is called on the ValueHolder.

Returns:

A ValueHolder holding a Reader to the page definition contents.

setPageDefinitionContent

public void setPageDefinitionContent(java.io.Reader input)

Set the contents of the Page Definition associated with this page, as a Reader.

Parameters:

input - A Reader for the page definition contents.

setPageDefinitionContentFromString

public void setPageDefinitionContentFromString(java.lang.String input)

Set the contents of the Page Definition associated with this page, as a String.

Parameters:

input - A String containing the page definition contents.

getPageDefinitionContent

public java.io.Reader getPageDefinitionContent()

Get a Reader for the contents of the Page Definition associated with this page.

Returns:

A ValueHolder holding a Reader to the page definition contents.

getInputFileName

public java.lang.String getInputFileName()

Get the input file name for use in the MDS path of Page View and Page Definition files.

By default, the file name in the MDS path is an internal name. If an input file name is provided, then it is used to override the internal name.

setInputFileName

public void setInputFileName(java.lang.String inputFileName)

Set the input file name for use in the MDS path of Page View and Page Definition files.

By default, the file name in the MDS path is an internal name. If an input file name is provided, then it is used to override the internal name.

getSourcePath

@Deprecated
public java.lang.String getSourcePath()

Deprecated.

Get the source path of JSPx file in MDS. This will be null unless this is a new, externally created property bean where the source path has been set by the caller.

setSourcePath

@Deprecated
public void setSourcePath(java.lang.String sourcePath)

Deprecated.

Set the source path of JSPx file in MDS.

setSourcePath is used for create only. When a page is created, the JSPx and Page Definition will be copied from the source path location to the target location in MDS. Each type has a pre-defined target location.

Both the JSPx file and Page Definition file are expected to at the same location. E.g. 1. /oracle/webcenter/page/templates/PortalsTemplate.jspx 2. /oracle/webcenter/page/templates/PortalsTemplatePageDef.xml The source path specifies the value of 1.

getPagePath

public java.lang.String getPagePath()

Get JSPx file path in MDS.

setPagePath

public void setPagePath(java.lang.String pagePath)

Set JSPx file path in MDS.

setPagePath is used for update only. If the JSPx and PageDefinition have moved to a new location in MDS, use setPagePath to specify the new MDS location. No new MDS document is created by update of this object.

Both the JSPx file and Page Definition file are expected to at the same location. E.g. 1. /oracle/webcenter/page/templates/PortalsTemplate.jspx 2. /oracle/webcenter/page/templates/PortalsTemplatePageDef.xml The page path specifies the value of 1.

getPageDefinitionPath

public java.lang.String getPageDefinitionPath()

Get Page Definition file path in MDS.

setPageDefinitionPath

public void setPageDefinitionPath(java.lang.String pageDefinitionPath)

Set Page Definition file path in MDS.

This property is read only; setting this value has no effect. Use setPagePath instead of this method to set the new location in MDS.

getSourcePageDefinitionPath

@Deprecated
public java.lang.String getSourcePageDefinitionPath()

Deprecated.

setSourcePageDefinitionPath

@Deprecated
public void setSourcePageDefinitionPath(java.lang.String sourcePageDefinitionPath)

Deprecated.

getPageViewType

@SetOnce
public PageViewType getPageViewType()

Gets the page view type.

Returns:

the page view type

setPageViewType

public void setPageViewType(PageViewType pageViewType)

Sets the page view type.

Note that the page view type is normally derived from the suffix of the path of the page view in MDS. However, when setting the page content for the first time you can set the page view type at the same time and that will be used to deterimne the suffix of the path used to store the document in MDS.

Parameters:

pageViewType - the page view type

See Also:

getPagePath()