com.bea.netuix.application.manager.persistence.jdbc
PortalCustomizationManagerImpl Class

public class PortalCustomizationManagerImpl

    extends Object
    implements IBookInstanceManager, IDesktopInstanceManager, IPageInstanceManager, IPortletInstanceManager, SessionBean

Hierarchy

Object
  PortalCustomizationManagerImpl

All Implemented Interfaces

EnterpriseBean, IBookInstanceManager, IDesktopInstanceManager, IPageInstanceManager, IPortletInstanceManager, Serializable, SessionBean

debug

protected static Debug debug

PortalCustomizationManagerImpl

public PortalCustomizationManagerImpl()

addNavigable(CustomizationContext, DesktopDefinitionId, BookInstanceId, NavigableDefinitionId, int, int) Method

public NavigableInstance addNavigable(CustomizationContext customizationContext, 
                                      DesktopDefinitionId desktopDefinitionId, 
                                      BookInstanceId bookInstanceId, 
                                      NavigableDefinitionId navigableDefinitionId, 
                                      int position, 
                                      int align)
     throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException, IllegalDependencyException

Create an new instance of a NavigableView (BookView or PageView) from the supplied NavigableDefinition object.

Parameters

customizationContext

the desktop context to which this update applies.

desktopDefinitionId

the book instance to add the navigable to.

bookInstanceId

the navigable defintion id from which to create the instance.

navigableDefinitionId

the position in the book (or menu) to insert this navigable (starts with 0)

position

position the page from the left (top) or right (bottom)

Returns

the NavigableView instance which was created.

Exceptions

RemoteException

ObjectNotFoundException

MissingDataException

NotEntitledException

IllegalDependencyException

addPlaceable(CustomizationContext, DesktopDefinitionId, PageInstanceId, PlaceableDefinitionId, PlaceholderDefinitionId, int) Method

public PlaceableInstance addPlaceable(CustomizationContext customizationContext, 
                                      DesktopDefinitionId desktopDefinitionId, 
                                      PageInstanceId pageInstanceId, 
                                      PlaceableDefinitionId placeableDefinitionId, 
                                      PlaceholderDefinitionId placeholderDefinitionId, 
                                      int position)
     throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException, IllegalDependencyException

Parameters

customizationContext

customization information such as prefered locales.

desktopDefinitionId

context of the desktop to which this applies

pageInstanceId

the page instance id of the page to add the placeable.

placeableDefinitionId

the abstract definition id of the placeable

placeholderDefinitionId

the placehoder to place this placeable in.

position

the position in the placeholder to insert the placeholder.

Returns

a fully populated placeable instance. This will be of a more concrete type depending on the placeable definition supplied.

Exceptions

RemoteException

ObjectNotFoundException

MissingDataException

NotEntitledException

IllegalDependencyException

createSuccessor(CustomizationContext, DesktopDefinitionId, PortletInstanceId) Method

public PortletInstanceId createSuccessor(CustomizationContext customizationContext, 
                                         DesktopDefinitionId desktopDefinitionId, 
                                         PortletInstanceId portletInstanceId)
     throws RemoteException, ObjectNotFoundException, NotEntitledException

Creates a successor instance and returns its instance ID. Returns the same instance ID if there is no need to create a successor instance.

Parameters

customizationContext

the desktop context to which this chage applies.

desktopDefinitionId

the portlet instance ID

Returns

successor instance ID

Exceptions

RemoteException

ObjectNotFoundException

NotEntitledException

deleteDesktopCustomizations(String) Method

public void deleteDesktopCustomizations(String username)
     throws RemoteException, NotEntitledException

Parameters

username

the login name of the user.

Exceptions

RemoteException

NotEntitledException

deletePortletInstance(CustomizationContext, PortletInstanceId) Method

public void deletePortletInstance(CustomizationContext customizationContext, 
                                  PortletInstanceId portletInstanceId)
     throws RemoteException, NotEntitledException

Deletes a portlet instance. Note that instances associated with other aggregating entities such as pages should not be deleted directly using this method.

Exceptions

RemoteException

NotEntitledException

ejbActivate() Method

public void ejbActivate()
     throws EJBException, RemoteException

Exceptions

EJBException

RemoteException

ejbCreate() Method

public void ejbCreate()
     throws CreateException, RemoteException

Exceptions

CreateException

RemoteException

ejbPassivate() Method

public void ejbPassivate()
     throws EJBException, RemoteException

Exceptions

EJBException

RemoteException

ejbRemove() Method

public void ejbRemove()
     throws EJBException, RemoteException

Exceptions

EJBException

RemoteException

getBookInstance(CustomizationContext, BookInstanceId) Method

public BookInstance getBookInstance(CustomizationContext customizationContext, 
                                    BookInstanceId bookInstanceId)
     throws RemoteException

Getter for returning a BookInstance identified by the supplieed instance id.

Parameters

customizationContext

customization information such as prefered locales and desktopInstanceId

bookInstanceId

the unique id of the instace to return

Returns

a fully populated internationalized BookInstance objects if it exist, otherwisez null.

Exceptions

RemoteException

getBookView(CustomizationContext, DesktopDefinitionId, BookInstanceId) Method

public BookView getBookView(CustomizationContext customizationContext, 
                            DesktopDefinitionId desktopDefinitionId, 
                            BookInstanceId bookInstanceId)
     throws RemoteException

Getter for returning an immutable deep copy of a BookView. The BookView object, unlike the BookDefinition or the BookInstance objects contains a deep copy of all references to all child pages, books and so on. The BookView object however is immutable.

Parameters

customizationContext

customization information such as prefered locales and desktopInstanceId returned.

desktopDefinitionId

the unique instance id of the book.

Returns

an immutable deep copy BookView object if one exist, otherwise null.

Exceptions

RemoteException

getCustomizedDesktopView(CustomizationContext, String, PortalPath, DesktopPath) Method

public DesktopView getCustomizedDesktopView(CustomizationContext customizationContext, 
                                            String webAppName, 
                                            PortalPath portalPath, 
                                            DesktopPath desktopPath)
     throws RemoteException

Getter for returning an immutable deep copy of a DesktopView. If the user has customized his deskotp then this will return the user's specific instance otherwise null is returned. The DesktopView object, unlike the DesktopDefinition or the DesktopInstance objects contains a deep copy of all references to all child pages, books and so on. The DesktopView object however is immutable.

Returns

an immutable deep copy DesktopView object if one exist, otherwise null.

Exceptions

RemoteException

getDesktopInstance(CustomizationContext, DesktopInstanceId) Method

public DesktopInstance getDesktopInstance(CustomizationContext customizationContext, 
                                          DesktopInstanceId desktopInstanceId)
     throws RemoteException

Getter for returning a DesktopInstance identified by the supplied instance id.

Returns

a fully populated internationalized DesktopInstance objects if it exist, otherwise null.

Exceptions

RemoteException

getDesktopView(CustomizationContext, String, PortalPath, DesktopPath) Method

public DesktopView getDesktopView(CustomizationContext customizationContext, 
                                  String webAppName, 
                                  PortalPath portalPath, 
                                  DesktopPath desktopPath)
     throws RemoteException

Getter for returning an immutable deep copy of a DesktopView. If the user has customized his deskotp then this will return the user's specific instance.The DesktopView object, unlike the DesktopDefinition or the DesktopInstance objects contains a deep copy of all references to all child pages, books and so on. The DesktopView object however is immutable.

Returns

an immutable deep copy DesktopView object if one exist, otherwise null.

Exceptions

RemoteException

getDesktopView(CustomizationContext, DesktopInstanceId) Method

public DesktopView getDesktopView(CustomizationContext customizationContext, 
                                  DesktopInstanceId desktopInstanceId)
     throws RemoteException

Getter for returning an immutable deep copy of a DesktopView. The DesktopView object, unlike the DesktopDefinition or the DesktopInstance objects contains a deep copy of all references to all child pages, books and so on. The DesktopView object however is immutable.

Returns

an immutable deep copy DesktopView object if one exist, otherwise null.

Exceptions

RemoteException

getPageInstance(CustomizationContext, PageInstanceId) Method

public PageInstance getPageInstance(CustomizationContext customizationContext, 
                                    PageInstanceId pageInstanceId)
     throws RemoteException

Getter for returning a single PageInstance.

Parameters

customizationContext

customization information such as prefered locales and desktopInstanceId returned.

Returns

an fully populated PageInstance object.

Exceptions

RemoteException

getPageView(CustomizationContext, DesktopDefinitionId, PageInstanceId) Method

public PageView getPageView(CustomizationContext customizationContext, 
                            DesktopDefinitionId desktopDefinitionId, 
                            PageInstanceId pageInstanceId)
     throws RemoteException

Getter for returning an immutable deep copy of a PageView. The PageView object, unlike the PageDefinition or the PageInstance objects contains a full set of references to all child pages, pages and so on. The PageView object however is immutable.

Parameters

customizationContext

customization information such as prefered locales and desktopInstanceId returned.

desktopDefinitionId

the desktop definition it this page is placed in

pageInstanceId

the unique pageInstanceId.

Returns

an immutable deep copy PageView object if one exist, otherwise null.

Exceptions

RemoteException

getPortletInstance(CustomizationContext, PortletInstanceId) Method

public PortletInstance getPortletInstance(CustomizationContext customizationContext, 
                                          PortletInstanceId portletInstanceId)
     throws RemoteException

Getter for returning a single PortletInstance.

Parameters

customizationContext

the prefered language, country and variant to which the titles and descriptions are returned.

Returns

an fully populated PortletInstance object.

Exceptions

RemoteException

getPortletView(CustomizationContext, PortletInstanceId) Method

public PortletView getPortletView(CustomizationContext customizationContext, 
                                  PortletInstanceId portletInstanceId)

Getter for returning an immutable deep copy of a PortletView. The PortletView object, unlike the PortletDefinition or the PortletInstance objects contains a full set of references to all child portlets, portlets and so on. The PortletView object however is immutable.

Parameters

customizationContext

customization information such as Locales and DesktopInstaceId

portletInstanceId

the unique portletInstanceId.

Returns

an immutable deep copy PortletView object if one exist, otherwise null.

getPredecessor(CustomizationContext, PortletInstanceId) Method

public PortletInstanceId getPredecessor(CustomizationContext customizationContext, 
                                        PortletInstanceId portletInstanceId)
     throws RemoteException, ObjectNotFoundException

Returns the instance ID that the given instance is based on. Returns null if there is no predecessor

Parameters

customizationContext

the portlet instance ID

Returns

successor instance ID

Exceptions

RemoteException

ObjectNotFoundException

getSuccessors(CustomizationContext, PortletInstanceId) Method

public PortletInstanceId[] getSuccessors(CustomizationContext customizationContext, 
                                       PortletInstanceId portletInstanceId)
     throws RemoteException, ObjectNotFoundException

Returns a list of successor instances. Returns an empty list if there are no successors.

Parameters

customizationContext

the portlet instance ID

Returns

array of successor instance IDs

Exceptions

RemoteException

ObjectNotFoundException

moveNavigable(CustomizationContext, DesktopDefinitionId, BookInstanceId, BookInstanceId, NavigableInstanceId, int, int) Method

public NavigableInstance moveNavigable(CustomizationContext customizationContext, 
                                       DesktopDefinitionId desktopDefinitionId, 
                                       BookInstanceId fromParentBookInstanceId, 
                                       BookInstanceId toParentBookInstanceId, 
                                       NavigableInstanceId navigableInstanceId, 
                                       int position, 
                                       int alignment)
     throws RemoteException, ObjectNotFoundException, NotEntitledException, IllegalDependencyException

Relocate the navigable instance to a new location.

Parameters

customizationContext

the desktop context to which this update applies.

desktopDefinitionId

the parent book instance id we are moving this navigable from.

fromParentBookInstanceId

the parent book instance to move the navigable instance to.

toParentBookInstanceId

the identifier identifying the instance to move.

navigableInstanceId

the position in the book (or menu) to insert this navigable (starts with 0)

position

position the page from the left (top) or right (bottom) reference the same book defnition.

Returns

a reference to the newly positioned navigableInstance

Exceptions

RemoteException

ObjectNotFoundException

NotEntitledException

IllegalDependencyException

movePlaceable(CustomizationContext, DesktopDefinitionId, PlacementId, PageInstanceId, PlaceholderDefinitionId, int) Method

public void movePlaceable(CustomizationContext customizationContext, 
                          DesktopDefinitionId desktopDefinitionId, 
                          PlacementId placementId, 
                          PageInstanceId toPageInstanceId, 
                          PlaceholderDefinitionId placeholderDefinitionId, 
                          int position)
     throws RemoteException, ObjectNotFoundException, NotEntitledException, IllegalDependencyException

Parameters

customizationContext

customization information such as prefered locales.

desktopDefinitionId

context of the desktop to which this applies

placementId

the placement id of the placeables current placement within the page

toPageInstanceId

the id of the page to move the placeable to.

placeholderDefinitionId

the new placehoder to place this placeable in.

position

the position in the placeholder to insert the placeholder.

Exceptions

RemoteException

ObjectNotFoundException

NotEntitledException

IllegalDependencyException

removeNavigable(CustomizationContext, DesktopDefinitionId, NavigableInstance) Method

public void removeNavigable(CustomizationContext customizationContext, 
                            DesktopDefinitionId desktopDefinitionId, 
                            NavigableInstance navigableInstance)
     throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException

Remove a NavigableView (BookView or PageView) from the specified book. This method does not delete the NavigableView it just removes it from the book.

Parameters

customizationContext

the desktop context to which this update applies.

desktopDefinitionId

the instance to be removed. reference the same book defnition.

Exceptions

RemoteException

ObjectNotFoundException

MissingDataException

NotEntitledException

removePlaceable(CustomizationContext, DesktopDefinitionId, PlaceableInstance) Method

public void removePlaceable(CustomizationContext customizationContext, 
                            DesktopDefinitionId desktopDefinitionId, 
                            PlaceableInstance placeableInstance)
     throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException

Parameters

customizationContext

customization information such as prefered locales.

desktopDefinitionId

context of the desktop to which this applies

placeableInstance

the instance to be removed

Exceptions

RemoteException

ObjectNotFoundException

MissingDataException

NotEntitledException

setDefaultNavigable(CustomizationContext, DesktopDefinitionId, BookInstanceId, NavigableInstanceId) Method

public void setDefaultNavigable(CustomizationContext customizationContext, 
                                DesktopDefinitionId desktopDefinitionId, 
                                BookInstanceId parentBookInstanceId, 
                                NavigableInstanceId navigableInstanceId)
     throws RemoteException, ObjectNotFoundException, NotEntitledException

Set the default navigable (page or book) on a page.

Parameters

customizationContext

the desktop context to which this update applies.

desktopDefinitionId

the parent book instance to set the default on.

parentBookInstanceId

the navigable instance id of the child page/book to become the default

Exceptions

RemoteException

ObjectNotFoundException

NotEntitledException

setSessionContext(SessionContext) Method

public void setSessionContext(SessionContext sessionContext)
     throws EJBException, RemoteException

Exceptions

EJBException

RemoteException

updateBookInstance(CustomizationContext, DesktopDefinitionId, BookInstance) Method

public BookInstance updateBookInstance(CustomizationContext customizationContext, 
                                       DesktopDefinitionId desktopDefinitionId, 
                                       BookInstance bookInstance)
     throws RemoteException, ObjectNotFoundException, NotEntitledException

Update the persistent store for the supplied BookInstance. All attributes of the BookInstance are updated in persistent store.

Parameters

customizationContext

the desktop context to which this update applies.

desktopDefinitionId

the book instance containing all the new data. reference the same book defnition.

Exceptions

RemoteException

ObjectNotFoundException

NotEntitledException

updateDesktopInstance(CustomizationContext, DesktopInstance) Method

public DesktopInstance updateDesktopInstance(CustomizationContext customizationContext, 
                                             DesktopInstance desktopInstance)
     throws RemoteException, ObjectNotFoundException, NotEntitledException

Update the persistent store for the supplied DesktopInstance. All attributes of the DesktopInstance are updated in persistent store.

Parameters

customizationContext

the new desktop instance containing all the new data.

Exceptions

RemoteException

ObjectNotFoundException

NotEntitledException

updatePageInstance(CustomizationContext, DesktopDefinitionId, PageInstance) Method

public PageInstance updatePageInstance(CustomizationContext customizationContext, 
                                       DesktopDefinitionId desktopDefinitionId, 
                                       PageInstance pageInstance)
     throws RemoteException, ObjectNotFoundException, NotEntitledException

Update the page instance with the new data.

Parameters

customizationContext

the desktop this instance is associated with

desktopDefinitionId

the page definition containing the new data

Exceptions

RemoteException

ObjectNotFoundException

NotEntitledException

updatePortletInstance(CustomizationContext, DesktopDefinitionId, PortletInstance) Method

public PortletInstance updatePortletInstance(CustomizationContext customizationContext, 
                                             DesktopDefinitionId desktopDefinitionId, 
                                             PortletInstance portletInstance)
     throws RemoteException, ObjectNotFoundException, NotEntitledException

Update the portlet instance with the new data. If the portlet instance is the primary portlet instance then a new instance will be created specifically for this user or admin.

For an admin editing a portlet outside the context of a desktop (in a Library) you should use updatePortletInstance(PortletInstance)

Parameters

customizationContext

the desktop context this instance is associated with.

desktopDefinitionId

the portlet instance containing the new data

Returns

the new updated portlet instance, with possible a new portletInstanceId

Exceptions

RemoteException

ObjectNotFoundException

NotEntitledException

updatePortletInstance(CustomizationContext, PortletInstance) Method

public PortletInstance updatePortletInstance(CustomizationContext customizationContext, 
                                             PortletInstance portletInstance)
     throws RemoteException, ObjectNotFoundException, NotEntitledException

Update the portlet instance outside the context of a desktop (in a Library). For Admins editing the primary instance (not placed on any page) use the PortletDefinitionManager.updatePortletDefinition().

Parameters

customizationContext

the portlet instance containing the new data

Returns

the new updated portlet instance.

Exceptions

RemoteException

ObjectNotFoundException

NotEntitledException