oracle.webcenter.portal.api

Interface BasePage<B extends BasePagePropertyBean>

All Superinterfaces:

ManagedPortalObject<B>, PortalObject<B>

All Known Subinterfaces:

Page, PageStyle, PageTemplate

public interface BasePage<B extends BasePagePropertyBean>
extends ManagedPortalObject<B>

This is the super interface for all "Page-like entities", such as Page, PageStyle, PageTemplate, etc.

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
void	addContentItem(ContentItem c) Add a content item to the Page.
void	addDPTaskFlow(ManagedPortalObject obj) Add an Application Integration Visualization to the Page.
void	addPageDefinitionParameter(java.lang.String id, java.lang.String value) Add a pageDefinition parameter If the parameter already exists, update the value
void	clearPageDefinitionParameter() Remove all parameters from the pageDefinition
<T extends ContentItem> T	getContentById(java.lang.Class<? extends ContentItem> type, java.lang.String contentId) Get the content for a specified type and content id.
<T extends ContentItem> java.util.List<T>	getContentByType(java.lang.Class<? extends ContentItem> type) Get all the content of a specified type associated with the Page.
<T extends ContentItem> java.util.List<T>	getContentItems() Get all the content associated with the Page.
java.util.List<ManagedPortalObject>	getDPTaskFlow() Get Application Integration Visualizations related to the Page.
Layout	getLayout() Gets the layout the page-like entity is currently using
java.util.Map<java.lang.String,java.lang.String>	getPageDefinitionParameters() Get parameters defined in pageDefinition
void	removeDPTaskFlow(ManagedPortalObject obj) Remove Application Integration Visualization from the Page.
void	removePageDefinitionParameter(java.lang.String id) Remove a parameter from the pageDefinition
void	setLayout(Layout layout) Sets the layout for the page-like entity
void	setLayout(java.lang.String layoutId) Sets the layout for the page-like entity
void	setPageDefinitionParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Set parameters in pageDefinition

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

addDPTaskFlow

void addDPTaskFlow(ManagedPortalObject obj)
            throws oracle.webcenter.portal.PortalOptimisticLockException

Add an Application Integration Visualization to the Page.

Parameters:

obj - The Visualization to add

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

removeDPTaskFlow

void removeDPTaskFlow(ManagedPortalObject obj)
               throws oracle.webcenter.portal.PortalOptimisticLockException

Remove Application Integration Visualization from the Page.

Parameters:

obj - The Visualization to remove

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

getDPTaskFlow

java.util.List<ManagedPortalObject> getDPTaskFlow()
                                           throws oracle.webcenter.portal.PortalOptimisticLockException

Get Application Integration Visualizations related to the Page.

Returns:

a Collection of visualizations for the Page

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

addContentItem

void addContentItem(ContentItem c)
             throws oracle.webcenter.portal.PortalOptimisticLockException

Add a content item to the Page.

Parameters:

c - The content item to add

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

getContentById

<T extends ContentItem> T getContentById(java.lang.Class<? extends ContentItem> type,
                                         java.lang.String contentId)
                                  throws oracle.webcenter.portal.PortalOptimisticLockException

Get the content for a specified type and content id.

Parameters:

type - the Class for the type of content to return, e.g. oracle.webcenter.portal.content.publisher.model.TextContentItem

contentId - id for the content item to return, the contentId is unique for a particular content type on a Page.

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

getContentByType

<T extends ContentItem> java.util.List<T> getContentByType(java.lang.Class<? extends ContentItem> type)
                                                    throws oracle.webcenter.portal.PortalOptimisticLockException

Get all the content of a specified type associated with the Page.

Parameters:

type - the Class for the type of content to return

Returns:

a Collection with the content items of type type for the Page

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

getContentItems

<T extends ContentItem> java.util.List<T> getContentItems()
                                                   throws oracle.webcenter.portal.PortalOptimisticLockException

Get all the content associated with the Page.

Returns:

a List with all content items for the Page

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

getPageDefinitionParameters

java.util.Map<java.lang.String,java.lang.String> getPageDefinitionParameters()

Get parameters defined in pageDefinition

Returns:

the parameters

setPageDefinitionParameters

void setPageDefinitionParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Set parameters in pageDefinition

Parameters:

parameters - the parameters to save in pageDefinition

addPageDefinitionParameter

void addPageDefinitionParameter(java.lang.String id,
                                java.lang.String value)

Add a pageDefinition parameter If the parameter already exists, update the value

Parameters:

id - the parameter id

value - the parameter value

removePageDefinitionParameter

void removePageDefinitionParameter(java.lang.String id)

Remove a parameter from the pageDefinition

Parameters:

id - the parameter id

clearPageDefinitionParameter

void clearPageDefinitionParameter()

Remove all parameters from the pageDefinition

getLayout

Layout getLayout()

Gets the layout the page-like entity is currently using

Returns:

the layout

setLayout

void setLayout(Layout layout)
        throws oracle.webcenter.portal.PortalOptimisticLockException

Sets the layout for the page-like entity

Parameters:

layout - the layout

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.

setLayout

void setLayout(java.lang.String layoutId)
        throws oracle.webcenter.portal.PortalOptimisticLockException

Sets the layout for the page-like entity

Parameters:

layoutId - the id of the layout

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.