org.gatein.api.navigation

Interface Navigation

public interface Navigation

Navigation for a site responsible for the retrieval, saving, and removal of navigation nodes.

Author:

Nick Scavelli, Stian Thorgersen

Method Summary

Methods

Modifier and Type	Method and Description
Node	getNode(NodePath nodePath) Returns a node represented by the node path or null if the node was not found.
Node	getNode(NodePath nodePath, NodeVisitor visitor) Returns a node represented by the node path or null if the node was not found.
Node	getNode(String... nodePath) Returns a node represented by the node path or null if the node was not found.
int	getPriority() The priority of the navigation.
Node	getRootNode(NodeVisitor visitor) Returns the root node of the navigation with nodes loaded dependent on the NodeVisitor
SiteId	getSiteId() The SiteId of the navigation
void	refreshNode(Node node) Will refresh the node with latest from storage.
void	refreshNode(Node node, NodeVisitor visitor) Will refresh the node with latest from storage.
boolean	removeNode(NodePath nodePath) Removes a node, represented by the node path
void	saveNode(Node node) Saves a node.
void	setPriority(int integer) Saves the priority for this navigation.

Method Detail

getSiteId

SiteId getSiteId()

The SiteId of the navigation

Returns:

the site id

getPriority

int getPriority()

The priority of the navigation. This can be used to determine the order in which navigations of the same SiteType appear in a navigation menu.

Returns:

the priority

setPriority

void setPriority(int integer)

Saves the priority for this navigation.

Parameters:

integer - the priority to save

Throws:

ApiException - if something prevented this operation to succeed

getNode

Node getNode(String... nodePath)

Returns a node represented by the node path or null if the node was not found.

Parameters:

nodePath - the path to the node

Returns:

the node or null if the node was not found

Throws:

IllegalArgumentException - if nodePath is null or empty

ApiException - if something prevented this operation to succeed

getNode

Node getNode(NodePath nodePath)

Returns a node represented by the node path or null if the node was not found.

Parameters:

nodePath - the path to the node

Returns:

the node or null if the node was not found

Throws:

IllegalArgumentException - if nodePath is null

ApiException - if something prevented this operation to succeed

getNode

Node getNode(NodePath nodePath,
           NodeVisitor visitor)

Returns a node represented by the node path or null if the node was not found. The NodeVisitor is then used to determine further loading of nodes.

For example if you want to retrieve the node /foo/bar but also want to load it's children you can pass in Nodes.visitChildren() as the visitor to load the children of /foo/bar.

Parameters:

nodePath - the path to the node

visitor - the visitor used to determine further loading of nodes. The visitor is relative to the node represented by the node path.

Returns:

the node or null if the node was not found

Throws:

IllegalArgumentException - if nodePath or visitor is null

ApiException - if something prevented this operation to succeed

getRootNode

Node getRootNode(NodeVisitor visitor)

Returns the root node of the navigation with nodes loaded dependent on the NodeVisitor

Parameters:

visitor - the visitor to determine how many nodes to load.

Returns:

the root node of the navigation

Throws:

IllegalArgumentException - if visitor is null

ApiException - if something prevented this operation to succeed

refreshNode

void refreshNode(Node node)

Will refresh the node with latest from storage. For example if nodes were added/removed, etc you can refresh/sync those changes. The refresh will affect the entire tree even if the node is not the root of the tree. When conflicting changes exist, a merge will be attempted, however it could fail and lead to a non resolvable situation.

Parameters:

node - the node to refresh

Throws:

IllegalArgumentException - if node is null

ApiException - if something prevented this operation to succeed

refreshNode

void refreshNode(Node node,
               NodeVisitor visitor)

Will refresh the node with latest from storage. The refresh will affect the entire tree even if the node is not the root of the tree. When conflicting changes exist, a merge will be attempted, however it could fail and lead to a non resolvable situation. The visitor can be used to control new nodes to load.

Parameters:

node - the node to refresh

visitor - the visitor which can load more nodes.

Throws:

IllegalArgumentException - if node or visitor is null

ApiException - if something prevented this operation to succeed

removeNode

boolean removeNode(NodePath nodePath)

Removes a node, represented by the node path

Parameters:

nodePath - the path to the node

Returns:

true if the node was removed, false otherwise

Throws:

IllegalArgumentException - if nodePath is null

EntityNotFoundException - if the node could not be found.

ApiException - if something prevented this operation to succeed

saveNode

void saveNode(Node node)

Saves a node. All changes to the entire tree will be saved even if the node is not the root of the tree.

Parameters:

node - the node to save

Throws:

IllegalArgumentException - if node is null

ApiException - if something prevented this operation to succeed