# com.bea.jsptools.portal
PortalVisitorManager Class

public class PortalVisitorManager
extends `Object`

Visitor Tool wrapper around the PortalManager. Customizations of visitor tool processing can be done in this class.

Hierarchy
  `Object`
  `PortalVisitorManager`

## Constructor Summary

PortalVisitorManager()

## Method Summary

`public static void` | `addNavigableInstances`(`NavigablePlacement`[] navigables, `String` webapp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static void` | `addPlaceableInstances`(`PlaceablePlacement`[] placeables, `String` webapp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static `String`` | `createBookDefinition`(`String` webapp, `String` title, `String` desc, `String` menuId, `Locale` locale, `HttpServletRequest` request)
`public static `String`` | `createPageDefinition`(`String` webapp, `String` title, `String` desc, `String` layoutId, `Locale` locale, `HttpServletRequest` request)
`public static `String`` | `crossSiteScriptFix`(`String` stringInput)
`public static `String`[]` | `generatePortletCategoryArrays`(`String` webAppName, `String` indentStr, `Locale` locale, `HttpServletRequest` request)
`public static `BookInstance`` | `getBookInstance`(`String` id, `Locale` locale, `HttpServletRequest` request)
`public static `BookView`` | `getBookView`(`String` bookInstanceId, `String` webAppName, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `DesktopView`` | `getDesktopView`(`String` portalPath, `String` webAppName, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `LayoutDefinition`[]` | `getLayoutDefinitions`(`String` webapp, `Locale` locale, `HttpServletRequest` request)
`public static `String`` | `getLayoutHtml`(`String` layoutHTMLPath, `String` currentWebApp)
`public static `LookAndFeelDefinition`[]` | `getLookAndFeelDefinitions`(`String` webapp, `Locale` locale, `HttpServletRequest` request)
`public static `MenuDefinition`[]` | `getMenuDefinitions`(`String` webapp, `Locale` locale, `HttpServletRequest` request)
`public static `PageInstance`` | `getPageInstance`(`String` id, `Locale` locale, `HttpServletRequest` request)
`public static `PageView`` | `getPageView`(`String` pageInstanceId, `String` webAppName, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `PortletDefinition`[]` | `getPortletDefinitions`(`String` webapp, `Locale` locale, `HttpServletRequest` request)
`public static `PortletInstance`` | `getPortletInstance`(`String` id, `Locale` locale, `HttpServletRequest` request)
`public static `PortletCategoryDefinition`` | `getPortletRootCategoryDefinition`(`String` webAppName, `Locale` locale, `HttpServletRequest` request)
`public static `HashMap`` | `getPortletsForCategory`(`PortletCategoryDefinition` portletCategoryDefinition, `Locale` locale, `HttpServletRequest` request)
`public static `HashMap`` | `getPortletsHash`(`PortletDefinition`[] portlets)
`public static `PortletCategoryDefinition`[]` | `getPortletSubCategoryDefinitions`(`PortletCategoryDefinitionId` pcdId, `Locale` locale, `HttpServletRequest` request)
`public static `BookDefinition`[]` | `getPublicBookDefinitions`(`String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `PageDefinition`[]` | `getPublicPageDefinitions`(`String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `ThemeDefinition`[]` | `getThemeDefinitions`(`String` webapp, `Locale` locale, `HttpServletRequest` request)
`public static boolean` | `isPlaceholderLocked`(`String` webApp, `String` portalPath, `String` desktopPath, `String` pageId, `String` placeholderNum, `HttpServletRequest` request)
`protected static void` | `log`(`String` message, `Exception` e)
`public static void` | `moveNavigableInstances`(`NavigablePlacement`[] navigables, `String` webapp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static void` | `movePlaceableInstances`(`PlaceablePlacement`[] placeables, `String` webapp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static void` | `removeNavigableInstances`(`NavigablePlacement`[] navigables, `String` webapp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static void` | `removePlaceableInstances`(`PlaceablePlacement`[] placeables, `String` webapp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static int` | `updateBookInstanceMenu`(`String` bookId, `String` newMenuId, `String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `updateBookInstanceTheme`(`String` bookId, `String` newThemeId, `String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `updateBookInstanceTitle`(`String` bookId, `String` newTitle, `String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `updateDesktopInstance`(`String` webapp, `String` portalPath, `String` desktopPath, `String` lookId, `Locale` locale, `HttpServletRequest` request)
`public static int` | `updatePageInstanceLayout`(`String` pageId, `String` layoutId, `String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `updatePageInstanceTheme`(`String` pageId, `String` newThemeId, `String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `updatePageInstanceTitle`(`String` pageId, `String` newTitle, `String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `updatePortletInstanceTheme`(`String` portletId, `String` newThemeId, `String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `updatePortletInstanceTitle`(`String` portletId, `String` newTitle, `String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)

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

## Constructor Detail

### PortalVisitorManager

    public PortalVisitorManager()

## Method Detail

### addNavigableInstances(NavigablePlacement[], String, String, String, HttpServletRequest) Method

    public static void addNavigableInstances(NavigablePlacement[] navigables,
                                             String webapp,
                                             String portalPath,
                                             String desktopPath,
                                             HttpServletRequest request)

### addPlaceableInstances(PlaceablePlacement[], String, String, String, HttpServletRequest) Method

    public static void addPlaceableInstances(PlaceablePlacement[] placeables,
                                             String webapp,
                                             String portalPath,
                                             String desktopPath,
                                             HttpServletRequest request)

### createBookDefinition(String, String, String, String, Locale, HttpServletRequest) Method

    public static String createBookDefinition(String webapp,
                                              String title,
                                              String desc,
                                              String menuId,
                                              Locale locale,
                                              HttpServletRequest request)

### createPageDefinition(String, String, String, String, Locale, HttpServletRequest) Method

    public static String createPageDefinition(String webapp,
                                              String title,
                                              String desc,
                                              String layoutId,
                                              Locale locale,
                                              HttpServletRequest request)

### crossSiteScriptFix(String) Method

    public static String crossSiteScriptFix(String stringInput)

### generatePortletCategoryArrays(String, String, Locale, HttpServletRequest) Method

    public static String[] generatePortletCategoryArrays(String webAppName,
                                                       String indentStr,
                                                       Locale locale,
                                                       HttpServletRequest request)

### getBookInstance(String, Locale, HttpServletRequest) Method

    public static BookInstance getBookInstance(String id,
                                               Locale locale,
                                               HttpServletRequest request)

### getBookView(String, String, String, String, Locale, HttpServletRequest) Method

    public static BookView getBookView(String bookInstanceId,
                                       String webAppName,
                                       String portalPath,
                                       String desktopPath,
                                       Locale locale,
                                       HttpServletRequest request)

### getDesktopView(String, String, String, Locale, HttpServletRequest) Method

    public static DesktopView getDesktopView(String portalPath,
                                             String webAppName,
                                             String desktopPath,
                                             Locale locale,
                                             HttpServletRequest request)

### getLayoutDefinitions(String, Locale, HttpServletRequest) Method

    public static LayoutDefinition[] getLayoutDefinitions(String webapp,
                                                        Locale locale,
                                                        HttpServletRequest request)

### getLayoutHtml(String, String) Method

    public static String getLayoutHtml(String layoutHTMLPath,
                                       String currentWebApp)

### getLookAndFeelDefinitions(String, Locale, HttpServletRequest) Method

    public static LookAndFeelDefinition[] getLookAndFeelDefinitions(String webapp,
                                                                  Locale locale,
                                                                  HttpServletRequest request)

### getMenuDefinitions(String, Locale, HttpServletRequest) Method

    public static MenuDefinition[] getMenuDefinitions(String webapp,
                                                    Locale locale,
                                                    HttpServletRequest request)

### getPageInstance(String, Locale, HttpServletRequest) Method

    public static PageInstance getPageInstance(String id,
                                               Locale locale,
                                               HttpServletRequest request)

### getPageView(String, String, String, String, Locale, HttpServletRequest) Method

    public static PageView getPageView(String pageInstanceId,
                                       String webAppName,
                                       String portalPath,
                                       String desktopPath,
                                       Locale locale,
                                       HttpServletRequest request)

### getPortletDefinitions(String, Locale, HttpServletRequest) Method

    public static PortletDefinition[] getPortletDefinitions(String webapp,
                                                          Locale locale,
                                                          HttpServletRequest request)

### getPortletInstance(String, Locale, HttpServletRequest) Method

    public static PortletInstance getPortletInstance(String id,
                                                     Locale locale,
                                                     HttpServletRequest request)

### getPortletRootCategoryDefinition(String, Locale, HttpServletRequest) Method

    public static PortletCategoryDefinition getPortletRootCategoryDefinition(String webAppName,
                                                                             Locale locale,
                                                                             HttpServletRequest request)

### getPortletsForCategory(PortletCategoryDefinition, Locale, HttpServletRequest) Method

    public static HashMap getPortletsForCategory(PortletCategoryDefinition portletCategoryDefinition,
                                                 Locale locale,
                                                 HttpServletRequest request)

### getPortletsHash(PortletDefinition[]) Method

    public static HashMap getPortletsHash(PortletDefinition[] portlets)

### getPortletSubCategoryDefinitions(PortletCategoryDefinitionId, Locale, HttpServletRequest) Method

    public static PortletCategoryDefinition[] getPortletSubCategoryDefinitions(PortletCategoryDefinitionId pcdId,
                                                                             Locale locale,
                                                                             HttpServletRequest request)

### getPublicBookDefinitions(String, String, String, Locale, HttpServletRequest) Method

    public static BookDefinition[] getPublicBookDefinitions(String webapp,
                                                          String portalPath,
                                                          String desktopPath,
                                                          Locale locale,
                                                          HttpServletRequest request)

### getPublicPageDefinitions(String, String, String, Locale, HttpServletRequest) Method

    public static PageDefinition[] getPublicPageDefinitions(String webapp,
                                                          String portalPath,
                                                          String desktopPath,
                                                          Locale locale,
                                                          HttpServletRequest request)

### getThemeDefinitions(String, Locale, HttpServletRequest) Method

    public static ThemeDefinition[] getThemeDefinitions(String webapp,
                                                      Locale locale,
                                                      HttpServletRequest request)

### isPlaceholderLocked(String, String, String, String, String, HttpServletRequest) Method

    public static boolean isPlaceholderLocked(String webApp,
                                              String portalPath,
                                              String desktopPath,
                                              String pageId,
                                              String placeholderNum,
                                              HttpServletRequest request)

### log(String, Exception) Method

    protected static void log(String message,
                              Exception e)

### moveNavigableInstances(NavigablePlacement[], String, String, String, HttpServletRequest) Method

    public static void moveNavigableInstances(NavigablePlacement[] navigables,
                                              String webapp,
                                              String portalPath,
                                              String desktopPath,
                                              HttpServletRequest request)

### movePlaceableInstances(PlaceablePlacement[], String, String, String, HttpServletRequest) Method

    public static void movePlaceableInstances(PlaceablePlacement[] placeables,
                                              String webapp,
                                              String portalPath,
                                              String desktopPath,
                                              HttpServletRequest request)

### removeNavigableInstances(NavigablePlacement[], String, String, String, HttpServletRequest) Method

    public static void removeNavigableInstances(NavigablePlacement[] navigables,
                                                String webapp,
                                                String portalPath,
                                                String desktopPath,
                                                HttpServletRequest request)

### removePlaceableInstances(PlaceablePlacement[], String, String, String, HttpServletRequest) Method

    public static void removePlaceableInstances(PlaceablePlacement[] placeables,
                                                String webapp,
                                                String portalPath,
                                                String desktopPath,
                                                HttpServletRequest request)

### updateBookInstanceMenu(String, String, String, String, String, Locale, HttpServletRequest) Method

    public static int updateBookInstanceMenu(String bookId,
                                             String newMenuId,
                                             String webapp,
                                             String portalPath,
                                             String desktopPath,
                                             Locale locale,
                                             HttpServletRequest request)

### updateBookInstanceTheme(String, String, String, String, String, Locale, HttpServletRequest) Method

    public static void updateBookInstanceTheme(String bookId,
                                               String newThemeId,
                                               String webapp,
                                               String portalPath,
                                               String desktopPath,
                                               Locale locale,
                                               HttpServletRequest request)

### updateBookInstanceTitle(String, String, String, String, String, Locale, HttpServletRequest) Method

    public static void updateBookInstanceTitle(String bookId,
                                               String newTitle,
                                               String webapp,
                                               String portalPath,
                                               String desktopPath,
                                               Locale locale,
                                               HttpServletRequest request)

### updateDesktopInstance(String, String, String, String, Locale, HttpServletRequest) Method

    public static void updateDesktopInstance(String webapp,
                                             String portalPath,
                                             String desktopPath,
                                             String lookId,
                                             Locale locale,
                                             HttpServletRequest request)

### updatePageInstanceLayout(String, String, String, String, String, Locale, HttpServletRequest) Method

    public static int updatePageInstanceLayout(String pageId,
                                               String layoutId,
                                               String webapp,
                                               String portalPath,
                                               String desktopPath,
                                               Locale locale,
                                               HttpServletRequest request)

### updatePageInstanceTheme(String, String, String, String, String, Locale, HttpServletRequest) Method

    public static void updatePageInstanceTheme(String pageId,
                                               String newThemeId,
                                               String webapp,
                                               String portalPath,
                                               String desktopPath,
                                               Locale locale,
                                               HttpServletRequest request)

### updatePageInstanceTitle(String, String, String, String, String, Locale, HttpServletRequest) Method

    public static void updatePageInstanceTitle(String pageId,
                                               String newTitle,
                                               String webapp,
                                               String portalPath,
                                               String desktopPath,
                                               Locale locale,
                                               HttpServletRequest request)

### updatePortletInstanceTheme(String, String, String, String, String, Locale, HttpServletRequest) Method

    public static void updatePortletInstanceTheme(String portletId,
                                                  String newThemeId,
                                                  String webapp,
                                                  String portalPath,
                                                  String desktopPath,
                                                  Locale locale,
                                                  HttpServletRequest request)

### updatePortletInstanceTitle(String, String, String, String, String, Locale, HttpServletRequest) Method

    public static void updatePortletInstanceTitle(String portletId,
                                                  String newTitle,
                                                  String webapp,
                                                  String portalPath,
                                                  String desktopPath,
                                                  Locale locale,
                                                  HttpServletRequest request)