# com.bea.jsptools.portal
Node Class

public class Node
extends `PrunableTreeNode`

Hierarchy
  `Object`
  `TreeNode`
  `PrunableTreeNode`
  `Node`

## Field Summary

`public static final `String`` | `GROUP_MGR_REF` String
`public static final `String`` | `USER_MGR_REF` String

Fields from com.bea.tree`.`TreeNode``
`nodePath, parent, VAR_NAME_CONSTANT, VAR_NAME_INCREMENT`

## Constructor Summary

Node(`String` id, `Locale` locale)
Node(`String` id)

## Method Summary

`public static `String`` | `escapeQuotes`(`String` source) Escape quotes from the passed parameter
`public `List`` | `findLineage`(int pstmt) Find the lineage of the node in the hierarchy.
`public static void` | `getChildren`(`String` webAppName, `PrunableTreeNode` parentNode, `String` groupName, int nextAvailId, `String` language, `HttpServletRequest` request, `TreeStateManager` treeStateManager, int pageSize, boolean expandAllLibraryNodes, `NodePruner` np) Retrieve all the children for the node.
`public static `BookDefinition`[]` | `getCurrentPaginatedBookDefinitions`(`TreeStateManager` treeStateManager, int pageSize, `String` nodePath, `String` nodeModifier, boolean checkDA, `String` webAppName, `HttpServletRequest` request)
`public static `LayoutDefinition`[]` | `getCurrentPaginatedLayoutDefinitions`(`TreeStateManager` treeStateManager, int pageSize, `String` nodePath, `String` webAppName, `HttpServletRequest` request)
`public static `LookAndFeelDefinition`[]` | `getCurrentPaginatedLookAndFeelDefinitions`(`TreeStateManager` treeStateManager, int pageSize, `String` nodePath, `String` webAppName, `HttpServletRequest` request)
`public static `MenuDefinition`[]` | `getCurrentPaginatedMenuDefinitions`(`TreeStateManager` treeStateManager, int pageSize, `String` nodePath, `String` webAppName, `HttpServletRequest` request)
`public static `PageDefinition`[]` | `getCurrentPaginatedPageDefinitions`(`TreeStateManager` treeStateManager, int pageSize, `String` nodePath, `String` nodeModifier, boolean checkDA, `String` webAppName, `HttpServletRequest` request)
`public static `PortletDefinition`[]` | `getCurrentPaginatedPortletDefinitions`(`TreeStateManager` treeStateManager, int pageSize, `String` nodePath, `String` nodeModifier, boolean checkDA, `String` webAppName, `HttpServletRequest` request)
`public static `ShellDefinition`[]` | `getCurrentPaginatedShellDefinitions`(`TreeStateManager` treeStateManager, int pageSize, `String` nodePath, `String` webAppName, `HttpServletRequest` request)
`public static `ThemeDefinition`[]` | `getCurrentPaginatedThemeDefinitions`(`TreeStateManager` treeStateManager, int pageSize, `String` nodePath, `String` webAppName, `HttpServletRequest` request)
`public `String`` | `getDesktopPath`()
`public `String`` | `getGroupName`()
`public `String`` | `getLabel`() Returns the unique Label for a portal resource definition
`public `String`` | `getLabelTwo`() Returns a second Label for a portal resource definition (for portlet instances where both the instance label and the definition label are needed for entitlement checks)
`public `String`` | `getNodeType`()
`public long` | `getPortalDefinitionId`()
`public `String`` | `getPortalPath`()
`public int` | `getSchemaId`() Returns the schemaId.
`public `String`` | `getSchemaName`() Returns the schemaName.
`public `String`` | `getWebAppName`()
`public void` | `setDesktopPath`(`String` path)
`public void` | `setDisplayName`(`String` displayName)
`public void` | `setGroupName`(`String` groupName)
`public void` | `setLabel`(`String` label)
`public void` | `setLabelTwo`(`String` labelTwo)
`public void` | `setNodeType`(`String` nodeType)
`public void` | `setPortalDefinitionId`(long id)
`public void` | `setPortalPath`(`String` path)
`public void` | `setSchemaId`(int schemaId) Sets the schemaId.
`public void` | `setSchemaName`(`String` schemaName) Sets the schemaName.
`public void` | `setWebAppName`(`String` name)
`public `String`` | `toString`()
`public static `String`` | `unescapeQuotes`(`String` source) Remove the unicode characters from the string and replace them with real quotes

Methods from `com.bea.treeutils.`PrunableTreeNode``
`checkEnabled, checkEnabled, checkEnabled, getJavascriptDefinition, isAdminRole, isEnabled, isRootDARole, isVisible, setEnabled, setVisible`

Methods from `com.bea.tree.`TreeNode``
`addChild, addChild, addChild, addChild, addProperty, equals, escapeQuotes, getChildren, getData, getDisplayName, getIconSrcClosed, getIconSrcOpen, getJavascriptDefinition, getName, getNodePath, getPageRangeBegin, getPageSize, getPaginatedNodeChildCount, getParent, getPathDelimeter, getPopup, getPopupText, getPreSubmitScript, getProperty, getSubmitFormName, getTree, getUrl, getUrlTargetName, getVarName, hasChildren, htmlChars, isExpanded, isPaginated, setData, setExpanded, setHasChildren, setIconSrcClosed, setIconSrcOpen, setName, setPageRangeBegin, setPageSize, setPaginated, setPaginatedNodeChildCount, setPathDelimeter, setPopup, setPopupText, setPreSubmitScript, setSubmitFormName, setTree, setUrl, unescapeQuotes`

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

## Field Detail

### GROUP_MGR_REF

    public static final String GROUP_MGR_REF

### USER_MGR_REF

    public static final String USER_MGR_REF

## Constructor Detail

### Node

    public Node(String id,
                Locale locale)

### Node

    public Node(String id)

## Method Detail

### escapeQuotes(String) Method

    public static String escapeQuotes(String source)

Escape quotes from the passed parameter

#### Returns

String

### findLineage(int) Method

    public List findLineage(int pstmt)

Find the lineage of the node in the hierarchy.

#### Parameters

pstmt
  query statement which is to be executed to get the lineage

#### Returns

a List of parent nodes of the passed in node

### getChildren(String, PrunableTreeNode, String, int, String, HttpServletRequest, TreeStateManager, int, boolean, NodePruner) Method

    public static void getChildren(String webAppName,
                                   PrunableTreeNode parentNode,
                                   String groupName,
                                   int nextAvailId,
                                   String language,
                                   HttpServletRequest request,
                                   TreeStateManager treeStateManager,
                                   int pageSize,
                                   boolean expandAllLibraryNodes,
                                   NodePruner np)
         throws JspException

Retrieve all the children for the node. Return the children as a List of node Objects

#### Exceptions

``JspException``

### getCurrentPaginatedBookDefinitions(TreeStateManager, int, String, String, boolean, String, HttpServletRequest) Method

    public static BookDefinition[] getCurrentPaginatedBookDefinitions(TreeStateManager treeStateManager,
                                                                    int pageSize,
                                                                    String nodePath,
                                                                    String nodeModifier,
                                                                    boolean checkDA,
                                                                    String webAppName,
                                                                    HttpServletRequest request)
         throws Exception

#### Exceptions

``Exception``

### getCurrentPaginatedLayoutDefinitions(TreeStateManager, int, String, String, HttpServletRequest) Method

    public static LayoutDefinition[] getCurrentPaginatedLayoutDefinitions(TreeStateManager treeStateManager,
                                                                        int pageSize,
                                                                        String nodePath,
                                                                        String webAppName,
                                                                        HttpServletRequest request)
         throws Exception

#### Exceptions

``Exception``

### getCurrentPaginatedLookAndFeelDefinitions(TreeStateManager, int, String, String, HttpServletRequest) Method

    public static LookAndFeelDefinition[] getCurrentPaginatedLookAndFeelDefinitions(TreeStateManager treeStateManager,
                                                                                  int pageSize,
                                                                                  String nodePath,
                                                                                  String webAppName,
                                                                                  HttpServletRequest request)
         throws Exception

#### Exceptions

``Exception``

### getCurrentPaginatedMenuDefinitions(TreeStateManager, int, String, String, HttpServletRequest) Method

    public static MenuDefinition[] getCurrentPaginatedMenuDefinitions(TreeStateManager treeStateManager,
                                                                    int pageSize,
                                                                    String nodePath,
                                                                    String webAppName,
                                                                    HttpServletRequest request)
         throws Exception

#### Exceptions

``Exception``

### getCurrentPaginatedPageDefinitions(TreeStateManager, int, String, String, boolean, String, HttpServletRequest) Method

    public static PageDefinition[] getCurrentPaginatedPageDefinitions(TreeStateManager treeStateManager,
                                                                    int pageSize,
                                                                    String nodePath,
                                                                    String nodeModifier,
                                                                    boolean checkDA,
                                                                    String webAppName,
                                                                    HttpServletRequest request)
         throws Exception

#### Exceptions

``Exception``

### getCurrentPaginatedPortletDefinitions(TreeStateManager, int, String, String, boolean, String, HttpServletRequest) Method

    public static PortletDefinition[] getCurrentPaginatedPortletDefinitions(TreeStateManager treeStateManager,
                                                                          int pageSize,
                                                                          String nodePath,
                                                                          String nodeModifier,
                                                                          boolean checkDA,
                                                                          String webAppName,
                                                                          HttpServletRequest request)
         throws Exception

#### Exceptions

``Exception``

### getCurrentPaginatedShellDefinitions(TreeStateManager, int, String, String, HttpServletRequest) Method

    public static ShellDefinition[] getCurrentPaginatedShellDefinitions(TreeStateManager treeStateManager,
                                                                      int pageSize,
                                                                      String nodePath,
                                                                      String webAppName,
                                                                      HttpServletRequest request)
         throws Exception

#### Exceptions

``Exception``

### getCurrentPaginatedThemeDefinitions(TreeStateManager, int, String, String, HttpServletRequest) Method

    public static ThemeDefinition[] getCurrentPaginatedThemeDefinitions(TreeStateManager treeStateManager,
                                                                      int pageSize,
                                                                      String nodePath,
                                                                      String webAppName,
                                                                      HttpServletRequest request)
         throws Exception

#### Exceptions

``Exception``

### getDesktopPath() Method

    public String getDesktopPath()

### getGroupName() Method

    public String getGroupName()

### getLabel() Method

    public String getLabel()

Returns the unique Label for a portal resource definition

#### Returns

String

### getLabelTwo() Method

    public String getLabelTwo()

Returns a second Label for a portal resource definition (for portlet instances where both the instance label and the definition label are needed for entitlement checks)

#### Returns

String

### getNodeType() Method

    public String getNodeType()

### getPortalDefinitionId() Method

    public long getPortalDefinitionId()

### getPortalPath() Method

    public String getPortalPath()

### getSchemaId() Method

    public int getSchemaId()

Returns the schemaId.

#### Returns

int

### getSchemaName() Method

    public String getSchemaName()

Returns the schemaName.

#### Returns

String

### getWebAppName() Method

    public String getWebAppName()

### setDesktopPath(String) Method

    public void setDesktopPath(String path)

### setDisplayName(String) Method

    public void setDisplayName(String displayName)

Overrides
  TreeNode.setDisplayName(String)

#### Parameters

displayName
  The displayed name of the tree node.

### setGroupName(String) Method

    public void setGroupName(String groupName)

### setLabel(String) Method

    public void setLabel(String label)

### setLabelTwo(String) Method

    public void setLabelTwo(String labelTwo)

### setNodeType(String) Method

    public void setNodeType(String nodeType)

### setPortalDefinitionId(long) Method

    public void setPortalDefinitionId(long id)

### setPortalPath(String) Method

    public void setPortalPath(String path)

### setSchemaId(int) Method

    public void setSchemaId(int schemaId)

Sets the schemaId.

#### Parameters

schemaId
  The schemaId to set

### setSchemaName(String) Method

    public void setSchemaName(String schemaName)

Sets the schemaName.

#### Parameters

schemaName
  The schemaName to set

### setWebAppName(String) Method

    public void setWebAppName(String name)

### toString() Method

    public String toString()

Overrides
  TreeNode.toString()

### unescapeQuotes(String) Method

    public static String unescapeQuotes(String source)

Remove the unicode characters from the string and replace them with real quotes

#### Returns

String