oracle.webcenter.portal.api

Interface NavigationNode

All Superinterfaces:

ManagedPortalObject<NavigationNodePropertyBean>, PortalObject<NavigationNodePropertyBean>

public interface NavigationNode
extends ManagedPortalObject<NavigationNodePropertyBean>

A NavigationNode instance represents a navigation node 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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_CONTENT_ITEM
static java.lang.String	TYPE_CONTENT_QUERY
static java.lang.String	TYPE_FOLDER
static java.lang.String	TYPE_LINK
static java.lang.String	TYPE_NAVIGATION_REFERENCE
static java.lang.String	TYPE_PAGE
static java.lang.String	TYPE_PAGE_LINK
static java.lang.String	TYPE_PAGES_QUERY
static java.lang.String	TYPE_PORTAL_QUERY
static java.lang.String	TYPE_ROOT
static java.lang.String	TYPE_SEPARATOR

Method Summary

Modifier and Type	Method and Description
NavigationNode	addChildNode(NavigationNode node) Add a child node
NavigationNode	addChildNode(NavigationNode node, NavigationNode nodeToFollow) Add a child node after a specific node
NavigationNode	addChildNode(Page page) Adds a child node for a Page
NavigationNode	addChildNode(Page page, java.util.List<java.util.Map<java.lang.String,java.lang.String>> parameters, NavigationNode nodeToFollow) Adds a child node for a Page after a specific node
NavigationNode	addChildNode(Page page, NavigationNode nodeToFollow) Adds a child node for a Page after a specific node
void	addPageVariant(Page page) Add a page variant to the node
NavigationNode	createNavigationPage(Portal portal, PageStyle pageStyle, java.lang.String title, java.lang.String description, java.lang.String keywords) Adds a new page as a child node The new node is added to the end
NavigationNode	createNavigationPage(Portal portal, PageStyle pageStyle, java.lang.String title, java.lang.String description, java.lang.String keywords, java.util.List<java.util.Map<java.lang.String,java.lang.String>> parameters, NavigationNode nodeToFollow) Adds a new page as a child node after a specific node
NavigationNode	createNavigationPage(Portal portal, PageStyle pageStyle, java.lang.String title, java.lang.String description, java.lang.String keywords, NavigationNode nodeToFollow) Adds a new page as a child node after a specific node
NavigationNode	createNavigationPage(Portal portal, java.lang.String pageStylePath, java.lang.String title, java.lang.String description, java.lang.String keywords) Deprecated.
NavigationNode	createNavigationPage(Portal portal, java.lang.String pageStylePath, java.lang.String title, java.lang.String description, java.lang.String keywords, java.util.List<java.util.Map<java.lang.String,java.lang.String>> parameters, NavigationNode nodeToFollow) Adds a new page as a child node after a specific node
NavigationNode	createNavigationPage(Portal portal, java.lang.String pageStylePath, java.lang.String title, java.lang.String description, java.lang.String keywords, NavigationNode nodeToFollow) Deprecated.
Page	createPageVariant(java.lang.String deviceGroupName) Creates a page variant for the node
Page	createPageVariant(java.lang.String deviceGroupName, PageStyle pageStyle) Creates a page variant for the node
java.lang.String	getAccessURL() Get the access url for the node
java.lang.String	getAccessURLWithExternalId() Get the access url for the node
NavigationNode	getChildNode(java.lang.String name) Gets a child node by name
java.util.List<NavigationNode>	getChildNodes() Get the list of the child nodes
NavigationNode	getNextNode() Get the next sibling
Page	getPage() Get the page of type Page associated with the NavigationNode
java.util.List<Page>	getPageVariants() Get the list of page variants
NavigationNode	getParentNode() Get the parent node
NavigationNode	getPreviousNode() Get the previous sibling
NavigationNode	getSiblingNode(java.lang.String name) Get sibling with a name
boolean	hasChild() Query to check if the node has child nodes
void	indent() Indent the node Make the node a child of its previous sibling.
boolean	isIndentAllowed() Check if the node can be indented
boolean	isMovedownAllowed() Check if the node can be moved down
boolean	isMoveupAllowed() Check if the node can be moved up
boolean	isOutdentAllowed() Check if the node can be outdented
void	moveBefore(NavigationNode node) Move the node before a specific node under the same parent
void	movedown() move the node down one position
void	moveup() move the node up one position
void	outdent() Outdent the node Make the node a sibling of its parent.
void	removeChildNode(NavigationNode node) Remove a child node
void	removePageVariant(Page page) Remove a page variant from the node
void	setPage(Page page) Set the page for the node
void	setParentNode(NavigationNode parentNode) Deprecated.

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

Field Detail

TYPE_ROOT

static final java.lang.String TYPE_ROOT

See Also:

Constant Field Values

TYPE_PAGE

static final java.lang.String TYPE_PAGE

See Also:

Constant Field Values

TYPE_CONTENT_ITEM

static final java.lang.String TYPE_CONTENT_ITEM

See Also:

Constant Field Values

TYPE_CONTENT_QUERY

static final java.lang.String TYPE_CONTENT_QUERY

See Also:

Constant Field Values

TYPE_PAGE_LINK

static final java.lang.String TYPE_PAGE_LINK

See Also:

Constant Field Values

TYPE_LINK

static final java.lang.String TYPE_LINK

See Also:

Constant Field Values

TYPE_PAGES_QUERY

static final java.lang.String TYPE_PAGES_QUERY

See Also:

Constant Field Values

TYPE_PORTAL_QUERY

static final java.lang.String TYPE_PORTAL_QUERY

See Also:

Constant Field Values

TYPE_NAVIGATION_REFERENCE

static final java.lang.String TYPE_NAVIGATION_REFERENCE

See Also:

Constant Field Values

TYPE_FOLDER

static final java.lang.String TYPE_FOLDER

See Also:

Constant Field Values

TYPE_SEPARATOR

static final java.lang.String TYPE_SEPARATOR

See Also:

Constant Field Values

Method Detail

getChildNodes

java.util.List<NavigationNode> getChildNodes()

Get the list of the child nodes

Returns:

a Collection with the child nodes of type NavigationNode for the NavigationNode

addChildNode

NavigationNode addChildNode(NavigationNode node)
                     throws oracle.webcenter.portal.PortalOptimisticLockException

Add a child node

Parameters:

node - the child node for the NavigationNode

Returns:

the child node

Throws:

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

addChildNode

NavigationNode addChildNode(NavigationNode node,
                            NavigationNode nodeToFollow)
                     throws oracle.webcenter.portal.PortalOptimisticLockException

Add a child node after a specific node

Parameters:

node - the child node for the NavigationNode

nodeToFollow - the node that the child node is placed after, if it is null, the child node is added to the end

Returns:

the child node

Throws:

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

addChildNode

NavigationNode addChildNode(Page page)
                     throws oracle.webcenter.portal.PortalOptimisticLockException

Adds a child node for a Page

Parameters:

page - the page

Returns:

the child node

Throws:

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

addChildNode

NavigationNode addChildNode(Page page,
                            NavigationNode nodeToFollow)
                     throws oracle.webcenter.portal.PortalOptimisticLockException

Adds a child node for a Page after a specific node

Parameters:

page - the page

nodeToFollow - the node that the child node is placed after, if it is null, the child node is added to the end

Returns:

the child node

Throws:

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

addChildNode

NavigationNode addChildNode(Page page,
                            java.util.List<java.util.Map<java.lang.String,java.lang.String>> parameters,
                            NavigationNode nodeToFollow)
                     throws oracle.webcenter.portal.PortalOptimisticLockException

Adds a child node for a Page after a specific node

Parameters:

page - the page

nodeToFollow - the node that the child node is placed after, if it is null, the child node is added to the end

parameters - the page parameters

Returns:

the child node

Throws:

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

createNavigationPage

@Deprecated
NavigationNode createNavigationPage(Portal portal,
                                                java.lang.String pageStylePath,
                                                java.lang.String title,
                                                java.lang.String description,
                                                java.lang.String keywords)
                                         throws DuplicateNameException,
                                                oracle.webcenter.portal.PortalOptimisticLockException

Deprecated.

Adds a new page as a child node The new node is added to the end

Parameters:

portal - the portal the new page should belong to

pageStylePath - the path of the page style to use to create the new page

description - the description for the new page

keywords - the keywords for the new page

Returns:

the created node

Throws:

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

DuplicateNameException

createNavigationPage

@Deprecated
NavigationNode createNavigationPage(Portal portal,
                                                java.lang.String pageStylePath,
                                                java.lang.String title,
                                                java.lang.String description,
                                                java.lang.String keywords,
                                                NavigationNode nodeToFollow)
                                         throws DuplicateNameException,
                                                oracle.webcenter.portal.PortalOptimisticLockException

Deprecated.

Adds a new page as a child node after a specific node

Parameters:

portal - the portal the new page should belong to

pageStylePath - the path of the page style to use to create the new page

description - the description for the new page

keywords - the keywords for the new page

nodeToFollow - the node that the new node is placed after, if it is null, the new node will be added at the end

Returns:

the created node

Throws:

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

DuplicateNameException

createNavigationPage

NavigationNode createNavigationPage(Portal portal,
                                    java.lang.String pageStylePath,
                                    java.lang.String title,
                                    java.lang.String description,
                                    java.lang.String keywords,
                                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> parameters,
                                    NavigationNode nodeToFollow)
                             throws DuplicateNameException,
                                    oracle.webcenter.portal.PortalOptimisticLockException

Adds a new page as a child node after a specific node

Parameters:

portal - the portal the new page should belong to

pageStylePath - the path of the page style to use to create the new page

description - the description for the new page

keywords - the keywords for the new page

parameters - the page parameters

nodeToFollow - the node that the new node is placed after, if it is null, the new node will be added at the end

Throws:

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

DuplicateNameException

createNavigationPage

NavigationNode createNavigationPage(Portal portal,
                                    PageStyle pageStyle,
                                    java.lang.String title,
                                    java.lang.String description,
                                    java.lang.String keywords)
                             throws DuplicateNameException,
                                    oracle.webcenter.portal.PortalOptimisticLockException

Adds a new page as a child node The new node is added to the end

Parameters:

portal - the portal the new page should belong to

pageStyle - the page style to use to create the new page

description - the description for the new page

keywords - the keywords for the new page

Throws:

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

DuplicateNameException

createNavigationPage

NavigationNode createNavigationPage(Portal portal,
                                    PageStyle pageStyle,
                                    java.lang.String title,
                                    java.lang.String description,
                                    java.lang.String keywords,
                                    NavigationNode nodeToFollow)
                             throws DuplicateNameException,
                                    oracle.webcenter.portal.PortalOptimisticLockException

Adds a new page as a child node after a specific node

Parameters:

portal - the portal the new page should belong to

pageStyle - the page style to use to create the new page

description - the description for the new page

keywords - the keywords for the new page

nodeToFollow - the node that the new node is placed after if it is null, the new node will be added at the end

Throws:

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

DuplicateNameException

createNavigationPage

NavigationNode createNavigationPage(Portal portal,
                                    PageStyle pageStyle,
                                    java.lang.String title,
                                    java.lang.String description,
                                    java.lang.String keywords,
                                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> parameters,
                                    NavigationNode nodeToFollow)
                             throws DuplicateNameException,
                                    oracle.webcenter.portal.PortalOptimisticLockException

Adds a new page as a child node after a specific node

Parameters:

portal - the portal the new page should belong to

pageStyle - the page style to use to create the new page

description - the description for the new page

keywords - the keywords for the new page

parameters - the page parameters

nodeToFollow - the node that the new node is placed after if it is null, the new node will be added at the end

Throws:

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

DuplicateNameException

createPageVariant

Page createPageVariant(java.lang.String deviceGroupName)

Creates a page variant for the node

Parameters:

deviceGroupName - the device group name

Returns:

the page variant of type Page

createPageVariant

Page createPageVariant(java.lang.String deviceGroupName,
                       PageStyle pageStyle)

Creates a page variant for the node

Parameters:

deviceGroupName - the device group name

pageStyle - the page style to use to create the page variant

Returns:

the page variant of type Page

getChildNode

NavigationNode getChildNode(java.lang.String name)

Gets a child node by name

Parameters:

name - the name

Returns:

the matching child node or null if not found

removeChildNode

void removeChildNode(NavigationNode node)
              throws oracle.webcenter.portal.PortalOptimisticLockException

Remove a child node

Parameters:

node - the child node to be removed for the NavigationNode

Throws:

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

getParentNode

NavigationNode getParentNode()

Get the parent node

Returns:

the parent node of type NavigationNode for the NavigationNode

getPreviousNode

NavigationNode getPreviousNode()

Get the previous sibling

Returns:

the sibling that is before the node

getNextNode

NavigationNode getNextNode()

Get the next sibling

Returns:

the sibling that is after the node

getSiblingNode

NavigationNode getSiblingNode(java.lang.String name)

Get sibling with a name

Returns:

the sibling whose name matches the specific name

getAccessURL

java.lang.String getAccessURL()

Get the access url for the node

Returns:

the access url

getAccessURLWithExternalId

java.lang.String getAccessURLWithExternalId()

Get the access url for the node

Returns:

the access url with externalId

setParentNode

@Deprecated
void setParentNode(NavigationNode parentNode)
                        throws oracle.webcenter.portal.PortalOptimisticLockException

Deprecated.

Set the parent node

Parameters:

parentNode - the new parent node of type NavigationNode for the NavigationNode

Throws:

oracle.webcenter.portal.PortalOptimisticLockException

getPageVariants

java.util.List<Page> getPageVariants()

Get the list of page variants

Returns:

a Collection with the page variants of type Page for the NavigationNode

addPageVariant

void addPageVariant(Page page)
             throws oracle.webcenter.portal.PortalOptimisticLockException

Add a page variant to the node

Parameters:

page - the page variant of the type Page for the NavigationNode

Throws:

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

removePageVariant

void removePageVariant(Page page)
                throws oracle.webcenter.portal.PortalOptimisticLockException

Remove a page variant from the node

Parameters:

page - page the page variant to be removed

Throws:

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

getPage

Page getPage()

Get the page of type Page associated with the NavigationNode

Returns:

the page of type Page for the NavigationNode

setPage

void setPage(Page page)
      throws oracle.webcenter.portal.PortalOptimisticLockException

Set the page for the node

Parameters:

page - the page of the type Page for the NavigationNode

Throws:

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

isIndentAllowed

boolean isIndentAllowed()

Check if the node can be indented

Returns:

true if the node can be indentd; otherwise return false

isOutdentAllowed

boolean isOutdentAllowed()

Check if the node can be outdented

Returns:

true if the node can be outdented; otherwise return false

isMoveupAllowed

boolean isMoveupAllowed()

Check if the node can be moved up

Returns:

true if the node can be moved up; otherwise return false

isMovedownAllowed

boolean isMovedownAllowed()

Check if the node can be moved down

Returns:

true if the node can be moved down; otherwise return false

indent

void indent()

Indent the node Make the node a child of its previous sibling.

outdent

void outdent()

Outdent the node Make the node a sibling of its parent.

moveup

void moveup()

move the node up one position

movedown

void movedown()

move the node down one position

moveBefore

void moveBefore(NavigationNode node)

Move the node before a specific node under the same parent

Parameters:

node - the node that the current node is placed before

hasChild

boolean hasChild()

Query to check if the node has child nodes