# com.bea.jsptools.portal
PortalAdminInstanceManager Class

public class PortalAdminInstanceManager
extends `PortalManager`

Hierarchy
  `Object`
  `PortalManager`
  `PortalAdminInstanceManager`

## Field Summary

`public static final `String`` | `I18N_FILE` String
`public static `PortalLogger`` | `logger` PortalLogger

Fields from com.bea.jsptools.portal`.`PortalManager``
``logger``

## Constructor Summary

PortalAdminInstanceManager()

## Method Summary

`public static void` | `addNavigableToBookInstance`(`String` navId, `String` bookId, `String` navType, `String` webApp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static void` | `addNewBookToBookInstance`(`String` bookId, `String` webAppName, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `addNewBookToPageInstance`(`String` pageId, `String` webAppName, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `addNewPageToBookInstance`(`String` bookId, `String` webAppName, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static void` | `addPlaceableToPageInstance`(`String` placeableId, `String` pageId, `String` placeableType, `String` webApp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static boolean` | `canPropagatePortletPreferences`(`String` portletId, `String` webAppName, `HttpServletRequest` request)
`public static `PortletInstanceId`` | `deletePortletPreference`(`String` portletId, `String` prefName, boolean checkForSuccessor, `String` webAppName, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static `BookView`` | `getBookView`(`String` bookInstanceId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `BookView`[]` | `getBookViews`(`String` bookInstanceId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `BookView`[]` | `getBookViewsForPage`(`String` pageInstanceId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `DesktopView`` | `getDesktopView`(`String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `DesktopView`[]` | `getDesktopViews`(`String` webApp, `String` portalPath, `Locale` locale, `HttpServletRequest` request)
`public static `PageView`` | `getPageView`(`String` pageInstanceId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `PageView`[]` | `getPageViews`(`String` bookInstanceId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `PortletInstance`` | `getPortletInstance`(`PortletInstanceId` pii, `Locale` locale, `HttpServletRequest` request)
`public static `Map`` | `getPortletPreferences`(`String` portletId, `String` webAppName, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static `PortletView`` | `getPortletView`(`String` portletInstanceId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `PortletView`[]` | `getPortletViews`(`String` pageInstanceId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static boolean` | `isPlaceholderLocked`(`String` webApp, `String` portalPath, `String` desktopPath, `String` pageId, `String` placeholderNum, `HttpServletRequest` request)
`public static void` | `moveNavigableInBookInstance`(`String` navId, `String` bookId, `String` navType, `String` navPosition, `String` webAppName, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static void` | `movePlaceableInstances`(`PlaceablePlacement`[] placeables, `String` pageId, `String` webApp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static `PortletInstanceId`` | `propagatePortletPreference`(`String` portletId, `String` webAppName, `HttpServletRequest` request)
`public static boolean` | `removeNavFromBookInstance`(`String` navId, `String` navType, `String` webApp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static boolean` | `removePlaceableFromPageInstance`(`String` placeableId, `String` placeableType, `String` webApp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static void` | `removePlaceableInstances`(`PlaceablePlacement`[] placeables, `String` webapp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static void` | `setDefaultNavigableInBookInstance`(`String` bookId, `String` navId, `String` navType, `String` webApp, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static void` | `setPlaceholderLock`(`String` webApp, `String` portalPath, `String` desktopPath, `String` pageId, `String` placeholderNum, `String` lockValue, `HttpServletRequest` request)
`public static `PortletInstanceId`` | `setPortletPreference`(`String` portletId, `String` prefName, `String` prefDescription, `String`[] prefValues, boolean isModifiable, boolean isMultiValue, boolean checkForSuccessor, `String` webAppName, `String` portalPath, `String` desktopPath, `HttpServletRequest` request)
`public static boolean` | `supportsPortletPreferences`(`String` portletId, `String` webAppName, `HttpServletRequest` request)
`public static `BookInstance`` | `updateBookInstance`(`String` bookId, `String` newMenuId, `String` newThemeId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `PageInstance`` | `updatePageInstance`(`String` pageId, `String` newLayoutId, `String` newThemeId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `PageInstance`` | `updatePageInstanceLayout`(`String` pageId, `String` newLayoutId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)
`public static `PortletInstance`` | `updatePortletInstance`(`String` id, `String` newThemeId, `String` webApp, `String` portalPath, `String` desktopPath, `Locale` locale, `HttpServletRequest` request)

Methods from `com.bea.jsptools.portal.`PortalManager``
``createBookDefinition`, `createPageDefinition`, `getBookInstance`, `getBookView`, `getDesktopView`, `getLayoutDefinitions`, `getLayoutHtml`, `getLookAndFeelDefinitions`, `getMenuDefinitions`, `getPageInstance`, `getPageView`, `getPortletDefinitions`, `getPortletInstance`, `getPublicBookDefinitions`, `getPublicPageDefinitions`, `getThemeDefinitions`, `isPlaceholderInstanceLocked`, `setPortalLogger`, `updateBookInstanceMenu`, `updateBookInstanceTheme`, `updateBookInstanceTitle`, `updateDesktopInstance`, `updatePageInstanceLayout`, `updatePageInstanceTheme`, `updatePageInstanceTitle`, `updatePortletInstanceTheme`, `updatePortletInstanceTitle``

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

## Field Detail

### I18N_FILE

    public static final String I18N_FILE

### logger

    public static PortalLogger logger

## Constructor Detail

### PortalAdminInstanceManager

    public PortalAdminInstanceManager()

## Method Detail

### addNavigableToBookInstance(String, String, String, String, String, String, HttpServletRequest) Method

    public static void addNavigableToBookInstance(String navId,
                                                  String bookId,
                                                  String navType,
                                                  String webApp,
                                                  String portalPath,
                                                  String desktopPath,
                                                  HttpServletRequest request)

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

    public static void addNewBookToBookInstance(String bookId,
                                                String webAppName,
                                                String portalPath,
                                                String desktopPath,
                                                Locale locale,
                                                HttpServletRequest request)

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

    public static void addNewBookToPageInstance(String pageId,
                                                String webAppName,
                                                String portalPath,
                                                String desktopPath,
                                                Locale locale,
                                                HttpServletRequest request)

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

    public static void addNewPageToBookInstance(String bookId,
                                                String webAppName,
                                                String portalPath,
                                                String desktopPath,
                                                Locale locale,
                                                HttpServletRequest request)

### addPlaceableToPageInstance(String, String, String, String, String, String, HttpServletRequest) Method

    public static void addPlaceableToPageInstance(String placeableId,
                                                  String pageId,
                                                  String placeableType,
                                                  String webApp,
                                                  String portalPath,
                                                  String desktopPath,
                                                  HttpServletRequest request)

### canPropagatePortletPreferences(String, String, HttpServletRequest) Method

    public static boolean canPropagatePortletPreferences(String portletId,
                                                         String webAppName,
                                                         HttpServletRequest request)

### deletePortletPreference(String, String, boolean, String, String, String, HttpServletRequest) Method

    public static PortletInstanceId deletePortletPreference(String portletId,
                                                            String prefName,
                                                            boolean checkForSuccessor,
                                                            String webAppName,
                                                            String portalPath,
                                                            String desktopPath,
                                                            HttpServletRequest request)

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

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

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

    public static BookView[] getBookViews(String bookInstanceId,
                                        String webApp,
                                        String portalPath,
                                        String desktopPath,
                                        Locale locale,
                                        HttpServletRequest request)

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

    public static BookView[] getBookViewsForPage(String pageInstanceId,
                                               String webApp,
                                               String portalPath,
                                               String desktopPath,
                                               Locale locale,
                                               HttpServletRequest request)

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

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

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

    public static DesktopView[] getDesktopViews(String webApp,
                                              String portalPath,
                                              Locale locale,
                                              HttpServletRequest request)

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

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

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

    public static PageView[] getPageViews(String bookInstanceId,
                                        String webApp,
                                        String portalPath,
                                        String desktopPath,
                                        Locale locale,
                                        HttpServletRequest request)

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

    public static PortletInstance getPortletInstance(PortletInstanceId pii,
                                                     Locale locale,
                                                     HttpServletRequest request)

### getPortletPreferences(String, String, String, String, HttpServletRequest) Method

    public static Map getPortletPreferences(String portletId,
                                            String webAppName,
                                            String portalPath,
                                            String desktopPath,
                                            HttpServletRequest request)

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

    public static PortletView getPortletView(String portletInstanceId,
                                             String webApp,
                                             String portalPath,
                                             String desktopPath,
                                             Locale locale,
                                             HttpServletRequest request)

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

    public static PortletView[] getPortletViews(String pageInstanceId,
                                              String webApp,
                                              String portalPath,
                                              String desktopPath,
                                              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)

### moveNavigableInBookInstance(String, String, String, String, String, String, String, HttpServletRequest) Method

    public static void moveNavigableInBookInstance(String navId,
                                                   String bookId,
                                                   String navType,
                                                   String navPosition,
                                                   String webAppName,
                                                   String portalPath,
                                                   String desktopPath,
                                                   HttpServletRequest request)

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

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

### propagatePortletPreference(String, String, HttpServletRequest) Method

    public static PortletInstanceId propagatePortletPreference(String portletId,
                                                               String webAppName,
                                                               HttpServletRequest request)

### removeNavFromBookInstance(String, String, String, String, String, HttpServletRequest) Method

    public static boolean removeNavFromBookInstance(String navId,
                                                    String navType,
                                                    String webApp,
                                                    String portalPath,
                                                    String desktopPath,
                                                    HttpServletRequest request)

### removePlaceableFromPageInstance(String, String, String, String, String, HttpServletRequest) Method

    public static boolean removePlaceableFromPageInstance(String placeableId,
                                                          String placeableType,
                                                          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)

### setDefaultNavigableInBookInstance(String, String, String, String, String, String, HttpServletRequest) Method

    public static void setDefaultNavigableInBookInstance(String bookId,
                                                         String navId,
                                                         String navType,
                                                         String webApp,
                                                         String portalPath,
                                                         String desktopPath,
                                                         HttpServletRequest request)

### setPlaceholderLock(String, String, String, String, String, String, HttpServletRequest) Method

    public static void setPlaceholderLock(String webApp,
                                          String portalPath,
                                          String desktopPath,
                                          String pageId,
                                          String placeholderNum,
                                          String lockValue,
                                          HttpServletRequest request)

### setPortletPreference(String, String, String, String[], boolean, boolean, boolean, String, String, String, HttpServletRequest) Method

    public static PortletInstanceId setPortletPreference(String portletId,
                                                         String prefName,
                                                         String prefDescription,
                                                         String[] prefValues,
                                                         boolean isModifiable,
                                                         boolean isMultiValue,
                                                         boolean checkForSuccessor,
                                                         String webAppName,
                                                         String portalPath,
                                                         String desktopPath,
                                                         HttpServletRequest request)

### supportsPortletPreferences(String, String, HttpServletRequest) Method

    public static boolean supportsPortletPreferences(String portletId,
                                                     String webAppName,
                                                     HttpServletRequest request)

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

    public static BookInstance updateBookInstance(String bookId,
                                                  String newMenuId,
                                                  String newThemeId,
                                                  String webApp,
                                                  String portalPath,
                                                  String desktopPath,
                                                  Locale locale,
                                                  HttpServletRequest request)

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

    public static PageInstance updatePageInstance(String pageId,
                                                  String newLayoutId,
                                                  String newThemeId,
                                                  String webApp,
                                                  String portalPath,
                                                  String desktopPath,
                                                  Locale locale,
                                                  HttpServletRequest request)

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

    public static PageInstance updatePageInstanceLayout(String pageId,
                                                        String newLayoutId,
                                                        String webApp,
                                                        String portalPath,
                                                        String desktopPath,
                                                        Locale locale,
                                                        HttpServletRequest request)

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

    public static PortletInstance updatePortletInstance(String id,
                                                        String newThemeId,
                                                        String webApp,
                                                        String portalPath,
                                                        String desktopPath,
                                                        Locale locale,
                                                        HttpServletRequest request)