# com.bea.jsptools.portal
PortalManager Class

public class PortalManager
extends `Object`

Hierarchy
  `Object`
  `PortalManager`

Direct Known Subclasses
  `PortalAdminInstanceManager`, `PortalAdminManager`

## Field Summary

`public static `PortalLogger`` | `logger` PortalLogger

## Constructor Summary

PortalManager()

## Method Summary

`public static `String`` | `createBookDefinition`(`String` webapp, `String` title, `String` desc, `String` menuId, boolean isPublic, `Locale` locale, `HttpServletRequest` request)
`public static `String`` | `createPageDefinition`(`String` webapp, `String` title, `String` desc, `String` layoutId, boolean isPublic, `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, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static `DesktopView`` | `getDesktopView`(`String` portalPath, `String` webAppName, `String` desktopPath, boolean visitorMode, `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, boolean visitorMode, `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 `BookDefinition`[]` | `getPublicBookDefinitions`(`String` webapp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `PageDefinition`[]` | `getPublicPageDefinitions`(`String` webapp, `String` portalPath, `String` desktopPath, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static `ThemeDefinition`[]` | `getThemeDefinitions`(`String` webapp, `Locale` locale, `HttpServletRequest` request)
`public static boolean` | `isPlaceholderInstanceLocked`(`String` webApp, `String` portalPath, `String` desktopPath, `String` pageId, `String` placeholderNum, `HttpServletRequest` request)
`public static void` | `setPortalLogger`(`PortalLogger` log)
`public static int` | `updateBookInstanceMenu`(`String` bookId, `String` newMenuId, `String` webapp, `String` portalPath, `String` desktopPath, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static int` | `updateBookInstanceTheme`(`String` bookId, `String` newThemeId, `String` webapp, `String` portalPath, `String` desktopPath, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static int` | `updateBookInstanceTitle`(`String` bookId, `String` newTitle, `String` webapp, `String` portalPath, `String` desktopPath, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static void` | `updateDesktopInstance`(`String` webapp, `String` portalPath, `String` desktopPath, `String` lookId, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static `PageInstance`` | `updatePageInstanceLayout`(`String` pageId, `String` layoutId, `String` webapp, `String` portalPath, `String` desktopPath, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static int` | `updatePageInstanceTheme`(`String` pageId, `String` newThemeId, `String` webapp, `String` portalPath, `String` desktopPath, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static int` | `updatePageInstanceTitle`(`String` pageId, `String` newTitle, `String` webapp, `String` portalPath, `String` desktopPath, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static `PortletInstance`` | `updatePortletInstanceTheme`(`String` portletId, `String` newThemeId, `String` webapp, `String` portalPath, `String` desktopPath, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)
`public static int` | `updatePortletInstanceTitle`(`String` portletId, `String` newTitle, `String` webapp, `String` portalPath, `String` desktopPath, boolean visitorMode, `Locale` locale, `HttpServletRequest` request)

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

## Field Detail

### logger

    public static PortalLogger logger

## Constructor Detail

### PortalManager

    public PortalManager()

## Method Detail

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

    public static String createBookDefinition(String webapp,
                                              String title,
                                              String desc,
                                              String menuId,
                                              boolean isPublic,
                                              Locale locale,
                                              HttpServletRequest request)
         throws MissingDataException, RemoteException, NotEntitledException

#### Exceptions

``MissingDataException``
``RemoteException``
``NotEntitledException``

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

    public static String createPageDefinition(String webapp,
                                              String title,
                                              String desc,
                                              String layoutId,
                                              boolean isPublic,
                                              Locale locale,
                                              HttpServletRequest request)
         throws MissingDataException, RemoteException, NotEntitledException

#### Exceptions

``MissingDataException``
``RemoteException``
``NotEntitledException``

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

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

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

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

    public static DesktopView getDesktopView(String portalPath,
                                             String webAppName,
                                             String desktopPath,
                                             boolean visitorMode,
                                             Locale locale,
                                             HttpServletRequest request)
         throws RemoteException

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

### 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)
         throws RemoteException

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

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

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

#### Exceptions

``RemoteException``

### isPlaceholderInstanceLocked(String, String, String, String, String, HttpServletRequest) Method

    public static boolean isPlaceholderInstanceLocked(String webApp,
                                                      String portalPath,
                                                      String desktopPath,
                                                      String pageId,
                                                      String placeholderNum,
                                                      HttpServletRequest request)
         throws RemoteException

#### Exceptions

``RemoteException``

### setPortalLogger(PortalLogger) Method

    public static void setPortalLogger(PortalLogger log)

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

    public static int updateBookInstanceMenu(String bookId,
                                             String newMenuId,
                                             String webapp,
                                             String portalPath,
                                             String desktopPath,
                                             boolean visitorMode,
                                             Locale locale,
                                             HttpServletRequest request)
         throws RemoteException, NotEntitledException, ObjectNotFoundException

#### Exceptions

``RemoteException``
``NotEntitledException``
``ObjectNotFoundException``

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

    public static int updateBookInstanceTheme(String bookId,
                                              String newThemeId,
                                              String webapp,
                                              String portalPath,
                                              String desktopPath,
                                              boolean visitorMode,
                                              Locale locale,
                                              HttpServletRequest request)
         throws RemoteException, NotEntitledException, ObjectNotFoundException

#### Exceptions

``RemoteException``
``NotEntitledException``
``ObjectNotFoundException``

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

    public static int updateBookInstanceTitle(String bookId,
                                              String newTitle,
                                              String webapp,
                                              String portalPath,
                                              String desktopPath,
                                              boolean visitorMode,
                                              Locale locale,
                                              HttpServletRequest request)
         throws RemoteException, NotEntitledException, ObjectNotFoundException

#### Exceptions

``RemoteException``
``NotEntitledException``
``ObjectNotFoundException``

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

    public static void updateDesktopInstance(String webapp,
                                             String portalPath,
                                             String desktopPath,
                                             String lookId,
                                             boolean visitorMode,
                                             Locale locale,
                                             HttpServletRequest request)
         throws RemoteException, ObjectNotFoundException, NotEntitledException

#### Exceptions

``RemoteException``
``ObjectNotFoundException``
``NotEntitledException``

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

    public static PageInstance updatePageInstanceLayout(String pageId,
                                                        String layoutId,
                                                        String webapp,
                                                        String portalPath,
                                                        String desktopPath,
                                                        boolean visitorMode,
                                                        Locale locale,
                                                        HttpServletRequest request)
         throws RemoteException, NotEntitledException, ObjectNotFoundException

#### Exceptions

``RemoteException``
``NotEntitledException``
``ObjectNotFoundException``

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

    public static int updatePageInstanceTheme(String pageId,
                                              String newThemeId,
                                              String webapp,
                                              String portalPath,
                                              String desktopPath,
                                              boolean visitorMode,
                                              Locale locale,
                                              HttpServletRequest request)
         throws RemoteException, NotEntitledException, ObjectNotFoundException

#### Exceptions

``RemoteException``
``NotEntitledException``
``ObjectNotFoundException``

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

    public static int updatePageInstanceTitle(String pageId,
                                              String newTitle,
                                              String webapp,
                                              String portalPath,
                                              String desktopPath,
                                              boolean visitorMode,
                                              Locale locale,
                                              HttpServletRequest request)
         throws RemoteException, NotEntitledException, ObjectNotFoundException

#### Exceptions

``RemoteException``
``NotEntitledException``
``ObjectNotFoundException``

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

    public static PortletInstance updatePortletInstanceTheme(String portletId,
                                                             String newThemeId,
                                                             String webapp,
                                                             String portalPath,
                                                             String desktopPath,
                                                             boolean visitorMode,
                                                             Locale locale,
                                                             HttpServletRequest request)
         throws RemoteException, NotEntitledException, ObjectNotFoundException

#### Exceptions

``RemoteException``
``NotEntitledException``
``ObjectNotFoundException``

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

    public static int updatePortletInstanceTitle(String portletId,
                                                 String newTitle,
                                                 String webapp,
                                                 String portalPath,
                                                 String desktopPath,
                                                 boolean visitorMode,
                                                 Locale locale,
                                                 HttpServletRequest request)
         throws RemoteException, NotEntitledException, ObjectNotFoundException

#### Exceptions

``RemoteException``
``NotEntitledException``
``ObjectNotFoundException``