|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bea.netuix.application.manager.persistence.jdbc.PortalCustomizationManagerImpl
Field Summary | |
protected static Debug |
debug
|
Constructor Summary | |
PortalCustomizationManagerImpl()
|
Method Summary | |
NavigableInstance |
addNavigable(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
BookInstanceId bookInstanceId,
NavigableDefinitionId navigableDefinitionId,
int position,
int align)
Create an new instance of a NavigableView (BookView or PageView) from the supplied
NavigableDefinition object. |
PlaceableInstance |
addPlaceable(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PageInstanceId pageInstanceId,
PlaceableDefinitionId placeableDefinitionId,
PlaceholderDefinitionId placeholderDefinitionId,
int position)
Create a new instance of a placeable (PortletView or BookView) by placing the definition in a placeholder. |
PortletInstanceId |
createSuccessor(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PortletInstanceId portletInstanceId)
Creates a successor instance and returns its instance ID. |
void |
deleteDesktopCustomizations(String username)
Delete/Remove all the customization for a particular user. |
void |
ejbActivate()
|
void |
ejbCreate()
|
void |
ejbPassivate()
|
void |
ejbRemove()
|
BookInstance |
getBookInstance(CustomizationContext customizationContext,
BookInstanceId bookInstanceId)
Getter for returning a BookInstance identified by the supplieed instance id. |
BookView |
getBookView(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
BookInstanceId bookInstanceId)
Getter for returning an immutable deep copy of a BookView. |
DesktopView |
getCustomizedDesktopView(CustomizationContext customizationContext,
String webAppName,
PortalPath portalPath,
DesktopPath desktopPath)
Getter for returning an immutable deep copy of a DesktopView. |
DesktopInstance |
getDesktopInstance(CustomizationContext customizationContext,
DesktopInstanceId desktopInstanceId)
Getter for returning a DesktopInstance identified by the supplied instance id. |
DesktopView |
getDesktopView(CustomizationContext customizationContext,
DesktopInstanceId desktopInstanceId)
Getter for returning an immutable deep copy of a DesktopView. |
DesktopView |
getDesktopView(CustomizationContext customizationContext,
String webAppName,
PortalPath portalPath,
DesktopPath desktopPath)
Getter for returning an immutable deep copy of a DesktopView. |
PageInstance |
getPageInstance(CustomizationContext customizationContext,
PageInstanceId pageInstanceId)
Getter for returning a single PageInstance . |
PageView |
getPageView(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PageInstanceId pageInstanceId)
Getter for returning an immutable deep copy of a PageView. |
PortletInstance |
getPortletInstance(CustomizationContext customizationContext,
PortletInstanceId portletInstanceId)
Getter for returning a single PortletInstance . |
PortletView |
getPortletView(CustomizationContext customizationContext,
PortletInstanceId portletInstanceId)
Getter for returning an immutable deep copy of a PortletView. |
PortletInstanceId |
getPredecessor(CustomizationContext customizationContext,
PortletInstanceId portletInstanceId)
Returns the instance ID that the given instance is based on. |
PortletInstanceId[] |
getSuccessors(CustomizationContext customizationContext,
PortletInstanceId portletInstanceId)
Returns a list of successor instances. |
NavigableInstance |
moveNavigable(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
BookInstanceId fromParentBookInstanceId,
BookInstanceId toParentBookInstanceId,
NavigableInstanceId navigableInstanceId,
int position,
int alignment)
Relocate the navigable instance to a new location. |
void |
movePlaceable(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PlacementId placementId,
PageInstanceId toPageInstanceId,
PlaceholderDefinitionId placeholderDefinitionId,
int position)
Move a placeable instance from one placeholder to another. |
void |
removeNavigable(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
NavigableInstance navigableInstance)
Remove a NavigableView (BookView or PageView) from the specified book. |
void |
removePlaceable(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PlaceableInstance placeableInstance)
Remove a placeable from a page's placeholder. |
void |
setDefaultNavigable(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
BookInstanceId parentBookInstanceId,
NavigableInstanceId navigableInstanceId)
Set the default navigable (page or book) on a page. |
void |
setSessionContext(SessionContext sessionContext)
|
BookInstance |
updateBookInstance(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
BookInstance bookInstance)
Update the persistent store for the supplied BookInstance . |
DesktopInstance |
updateDesktopInstance(CustomizationContext customizationContext,
DesktopInstance desktopInstance)
Update the persistent store for the supplied DesktopInstance . |
PageInstance |
updatePageInstance(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PageInstance pageInstance)
Update the page instance with the new data. |
PortletInstance |
updatePortletInstance(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PortletInstance portletInstance)
Update the portlet instance with the new data. |
PortletInstance |
updatePortletInstance(CustomizationContext customizationContext,
PortletInstance portletInstance)
Update the portlet instance outside the context of a desktop (in a Library). |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static Debug debug
Constructor Detail |
public PortalCustomizationManagerImpl()
Method Detail |
public void ejbCreate() throws CreateException, RemoteException
CreateException
RemoteException
public void ejbActivate() throws EJBException, RemoteException
ejbActivate
in interface SessionBean
EJBException
RemoteException
public void ejbPassivate() throws EJBException, RemoteException
ejbPassivate
in interface SessionBean
EJBException
RemoteException
public void ejbRemove() throws EJBException, RemoteException
ejbRemove
in interface SessionBean
EJBException
RemoteException
public void setSessionContext(SessionContext sessionContext) throws EJBException, RemoteException
setSessionContext
in interface SessionBean
EJBException
RemoteException
public PortletView getPortletView(CustomizationContext customizationContext, PortletInstanceId portletInstanceId)
IPortletInstanceManager
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.
getPortletView
in interface IPortletInstanceManager
customizationContext
- customization information such as Locales and DesktopInstaceIdportletInstanceId
- the unique portletInstanceId.
public PortletInstance getPortletInstance(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException
IPortletInstanceManager
Getter for returning a single PortletInstance
.
getPortletInstance
in interface IPortletInstanceManager
customizationContext
- the prefered language, country and variant to which the titles and descriptions are
returned.
RemoteException
PortletDefinition
public PortletInstance updatePortletInstance(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PortletInstance portletInstance) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPortletInstanceManager
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)
.
updatePortletInstance
in interface IPortletInstanceManager
desktopDefinitionId
- the desktop context this instance is associated with.portletInstance
- the portlet instance containing the new data
ObjectNotFoundException
- if the PortletInstanceId in the PortletInstance, or desktopInstanceId
is bogus.
RemoteException
NotEntitledException
IPortletInstanceManager.updatePortletInstance(CustomizationContext,PortletInstance)
public PortletInstance updatePortletInstance(CustomizationContext customizationContext, PortletInstance portletInstance) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPortletInstanceManager
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().
updatePortletInstance
in interface IPortletInstanceManager
portletInstance
- the portlet instance containing the new data
ObjectNotFoundException
- if the PortletInstanceId in the PortletInstance
is bogus.
RemoteException
NotEntitledException
public PortletInstanceId getPredecessor(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException, ObjectNotFoundException
IPortletInstanceManager
Returns the instance ID that the given instance is based
on. Returns null
if there is no predecessor
getPredecessor
in interface IPortletInstanceManager
portletInstanceId
- the portlet instance ID
ObjectNotFoundException
- if the PortletInstanceId does
not exist.
RemoteException
public PortletInstanceId[] getSuccessors(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException, ObjectNotFoundException
IPortletInstanceManager
Returns a list of successor instances. Returns an empty list if there are no successors.
getSuccessors
in interface IPortletInstanceManager
portletInstanceId
- the portlet instance ID
ObjectNotFoundException
- if the PortletInstanceId does
not exist.
RemoteException
public PortletInstanceId createSuccessor(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PortletInstanceId portletInstanceId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPortletInstanceManager
Creates a successor instance and returns its instance ID. Returns the same instance ID if there is no need to create a successor instance.
createSuccessor
in interface IPortletInstanceManager
desktopDefinitionId
- the desktop context to which this chage applies.portletInstanceId
- the portlet instance ID
ObjectNotFoundException
- if the PortletInstanceId does
not exist.
RemoteException
NotEntitledException
public PageView getPageView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstanceId pageInstanceId) throws RemoteException
IPageInstanceManager
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.
getPageView
in interface IPageInstanceManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.desktopDefinitionId
- the desktop definition it this page is placed inpageInstanceId
- the unique pageInstanceId.
RemoteException
public PageInstance getPageInstance(CustomizationContext customizationContext, PageInstanceId pageInstanceId) throws RemoteException
IPageInstanceManager
Getter for returning a single PageInstance
.
getPageInstance
in interface IPageInstanceManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.
RemoteException
PageDefinition
public PageInstance updatePageInstance(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstance pageInstance) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPageInstanceManager
Update the page instance with the new data.
updatePageInstance
in interface IPageInstanceManager
desktopDefinitionId
- the desktop this instance is associated withpageInstance
- the page definition containing the new data
ObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.
RemoteException
NotEntitledException
public PlaceableInstance addPlaceable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstanceId pageInstanceId, PlaceableDefinitionId placeableDefinitionId, PlaceholderDefinitionId placeholderDefinitionId, int position) throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException, IllegalDependencyException
IPageInstanceManager
addPlaceable
in interface IPageInstanceManager
customizationContext
- customization information such as prefered locales.desktopDefinitionId
- context of the desktop to which this appliespageInstanceId
- the page instance id of the page to add the placeable.placeableDefinitionId
- the abstract definition id of the placeableplaceholderDefinitionId
- the placehoder to place this placeable in.position
- the position in the placeholder to insert the placeholder.
ObjectNotFoundException
- if the PageDefinitionId or the PlaceholderDefinition Id are bogus
NotEntitledException
- the caller is not entitled to perform this action
IllegalDependencyException
- adding the Placeable to the PageInstance would cause a recursive dependancy
MissingDataException
- the placeableDefinition is missing some vital data.
RemoteException
public void movePlaceable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PlacementId placementId, PageInstanceId toPageInstanceId, PlaceholderDefinitionId placeholderDefinitionId, int position) throws RemoteException, ObjectNotFoundException, NotEntitledException, IllegalDependencyException
IPageInstanceManager
movePlaceable
in interface IPageInstanceManager
customizationContext
- customization information such as prefered locales.desktopDefinitionId
- context of the desktop to which this appliesplacementId
- the placement id of the placeables current placement within the pagetoPageInstanceId
- 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.
NotEntitledException
- the caller is not entitled to perform this action
ObjectNotFoundException
- if the PageDefinitionId or the PlaceholderDefinition Id are bogus
RemoteException
IllegalDependencyException
public void removePlaceable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PlaceableInstance placeableInstance) throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException
IPageInstanceManager
removePlaceable
in interface IPageInstanceManager
customizationContext
- customization information such as prefered locales.desktopDefinitionId
- context of the desktop to which this appliesplaceableInstance
- the instance to be removed
NotEntitledException
- the caller is not entitled to perform this action
ObjectNotFoundException
- If the padeDefinitionId or the placeableInstanceId are bogus
definition is in use by other instance.
RemoteException
MissingDataException
public BookView getBookView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, BookInstanceId bookInstanceId) throws RemoteException
IBookInstanceManager
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.
getBookView
in interface IBookInstanceManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.bookInstanceId
- the unique instance id of the book.
RemoteException
IBookDefinitionManager.getBookView(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.BookDefinitionId)
public BookInstance getBookInstance(CustomizationContext customizationContext, BookInstanceId bookInstanceId) throws RemoteException
IBookInstanceManager
Getter for returning a BookInstance
identified by the supplieed instance id.
getBookInstance
in interface IBookInstanceManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdbookInstanceId
- the unique id of the instace to return
BookInstance
objects if it exist, otherwisez null.
RemoteException
public BookInstance updateBookInstance(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, BookInstance bookInstance) throws RemoteException, ObjectNotFoundException, NotEntitledException
IBookInstanceManager
Update the persistent store for the supplied BookInstance
. All attributes of the BookInstance
are updated in persistent store.
updateBookInstance
in interface IBookInstanceManager
desktopDefinitionId
- the desktop context to which this update applies.bookInstance
- the book instance containing all the new data.
reference the same book defnition.
ObjectNotFoundException
- the BookInstanceId specified in the bookInstance is bogus.
RemoteException
NotEntitledException
public NavigableInstance addNavigable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, BookInstanceId bookInstanceId, NavigableDefinitionId navigableDefinitionId, int position, int align) throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException, IllegalDependencyException
IBookInstanceManager
Create an new instance of a NavigableView
(BookView or PageView) from the supplied
NavigableDefinition object.
addNavigable
in interface IBookInstanceManager
desktopDefinitionId
- the desktop context to which this update applies.bookInstanceId
- the book instance to add the navigable to.navigableDefinitionId
- the navigable defintion id from which to create the instance.position
- the position in the book (or menu) to insert this navigable (starts with 0)align
- position the page from the left (top) or right (bottom)
IllegalDependencyException
- adding the Navigable to the BookInstance would cause a recursive dependancy
MissingDataException
- missing vital data in the NavigableDefinition.
ObjectNotFoundException
- BookDefinitionId or the NavigableDefinition are bogus.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
RemoteException
public NavigableInstance moveNavigable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, BookInstanceId fromParentBookInstanceId, BookInstanceId toParentBookInstanceId, NavigableInstanceId navigableInstanceId, int position, int alignment) throws RemoteException, ObjectNotFoundException, NotEntitledException, IllegalDependencyException
IBookInstanceManager
Relocate the navigable instance to a new location.
moveNavigable
in interface IBookInstanceManager
desktopDefinitionId
- the desktop context to which this update applies.fromParentBookInstanceId
- the parent book instance id we are moving this navigable from.toParentBookInstanceId
- the parent book instance to move the navigable instance to.navigableInstanceId
- the identifier identifying the instance to move.position
- the position in the book (or menu) to insert this navigable (starts with 0)alignment
- position the page from the left (top) or right (bottom)
reference the same book defnition.
IllegalDependencyException
- if this move would cause an infinite loop condition
NotEntitledException
- if the caller does not have the required permissions to delete this object.
ObjectNotFoundException
- BookInstanceId or the NavigableInstanceId are bogus.
RemoteException
public void removeNavigable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, NavigableInstance navigableInstance) throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException
IBookInstanceManager
Remove a NavigableView (BookView or PageView) from the specified book. This method does not delete the NavigableView it just removes it from the book.
removeNavigable
in interface IBookInstanceManager
desktopDefinitionId
- the desktop context to which this update applies.navigableInstance
- the instance to be removed.
reference the same book defnition.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
ObjectNotFoundException
- BookInstanceId or the NavigableInstanceId are bogus.
RemoteException
MissingDataException
public void setDefaultNavigable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, BookInstanceId parentBookInstanceId, NavigableInstanceId navigableInstanceId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IBookInstanceManager
Set the default navigable (page or book) on a page.
setDefaultNavigable
in interface IBookInstanceManager
desktopDefinitionId
- the desktop context to which this update applies.parentBookInstanceId
- the parent book instance to set the default on.navigableInstanceId
- the navigable instance id of the child page/book to become the default
NotEntitledException
- if the caller does not have the required permissions to delete this object.
ObjectNotFoundException
- BookInstanceId or the NavigableInstanceId are bogus.
RemoteException
public DesktopView getDesktopView(CustomizationContext customizationContext, String webAppName, PortalPath portalPath, DesktopPath desktopPath) throws RemoteException
IDesktopInstanceManager
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.
getDesktopView
in interface IDesktopInstanceManager
customizationContext
- webAppName
- the name of the webappportalPath
- the partial portal pathdesktopPath
- the partial desktop path
RemoteException
IDesktopDefinitionManager.getDesktopView(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId)
public DesktopView getCustomizedDesktopView(CustomizationContext customizationContext, String webAppName, PortalPath portalPath, DesktopPath desktopPath) throws RemoteException
IDesktopInstanceManager
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.
getCustomizedDesktopView
in interface IDesktopInstanceManager
customizationContext
- webAppName
- the name of the webappportalPath
- the partial portal pathdesktopPath
- the partial desktop path
RemoteException
IDesktopDefinitionManager.getDesktopView(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId)
public DesktopView getDesktopView(CustomizationContext customizationContext, DesktopInstanceId desktopInstanceId) throws RemoteException
IDesktopInstanceManager
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.
getDesktopView
in interface IDesktopInstanceManager
customizationContext
- desktopInstanceId
- the unique instance id (webapp/portlaPath/desktopPath) of the desktop.
RemoteException
IDesktopDefinitionManager.getDesktopView(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId)
public DesktopInstance getDesktopInstance(CustomizationContext customizationContext, DesktopInstanceId desktopInstanceId) throws RemoteException
IDesktopInstanceManager
Getter for returning a DesktopInstance
identified by the supplied instance id.
getDesktopInstance
in interface IDesktopInstanceManager
customizationContext
- desktopInstanceId
- the unique id of the instance to return
DesktopInstance
objects if it exist, otherwise null.
RemoteException
public DesktopInstance updateDesktopInstance(CustomizationContext customizationContext, DesktopInstance desktopInstance) throws RemoteException, ObjectNotFoundException, NotEntitledException
IDesktopInstanceManager
Update the persistent store for the supplied DesktopInstance
. All attributes of the DesktopInstance
are updated in persistent store.
updateDesktopInstance
in interface IDesktopInstanceManager
desktopInstance
- the new desktop instance containing all the new data.
ObjectNotFoundException
- the DesktopInstanceId specified in the desktopInstance is bogus.
NotEntitledException
- if the caller does not have the required permissions to update this object.
RemoteException
public void deleteDesktopCustomizations(String username) throws RemoteException, NotEntitledException
IDesktopInstanceManager
deleteDesktopCustomizations
in interface IDesktopInstanceManager
username
- the login name of the user.
NotEntitledException
- if the caller does not have the required permissions to delete this customization
RemoteException
|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |