|
© 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.PageDefinitionManagerImpl
Constructor Summary | |
PageDefinitionManagerImpl()
|
Method Summary | |
PlaceableInstance |
addPlaceable(CustomizationContext customizationContext,
PageDefinitionId pageDefinitionId,
PlaceableDefinitionId placeableDefinitionId,
PlaceholderDefinitionId placeholderDefinitionId,
int position)
Create a new instance of a placeable (PortletView or BookView) by placing the definition in a placeholder. |
LayoutDefinition |
createLayoutDefinition(CustomizationContext customizationContext,
LayoutDefinition layoutDefinition)
Creates a new LayoutView Definition with its placeholders. |
PageDefinition |
createPageDefinition(CustomizationContext customizationContext,
PageDefinition pageDefinition)
Create a new page definition. |
void |
deleteLayoutDefinition(CustomizationContext customizationContext,
LayoutDefinitionId layoutDefinitionId)
Delete a layout definition and all its associated placeholders.. |
void |
deleteLayoutDefinitionWithReplacement(CustomizationContext customizationContext,
LayoutDefinitionId deleteLayoutDefinitionId,
LayoutDefinitionId replacementLayoutDefinitionId)
Delete a layout definition (and its placeholders) and replace any uses of that layout with a replacement layout. |
void |
deletePageDefinition(CustomizationContext customizationContext,
PageDefinitionId pageDefinitionId)
Delete a page definition, but only if it is not used byt other page instances. |
void |
deletePageDefinitionWithCascade(CustomizationContext customizationContext,
PageDefinitionId pageDefinitionId)
Delete a page definition and all page instances associated with this definition. |
void |
deletePageDefinitionWithReplacement(CustomizationContext customizationContext,
PageDefinitionId deletePageDefinitionId,
PageDefinitionId replacementPageDefinitionId)
Delete an existing page definition and if it is in use replace it's use with the supplied page defintion. |
void |
ejbActivate()
|
void |
ejbCreate()
|
void |
ejbPassivate()
|
void |
ejbRemove()
|
LayoutDefinition |
getLayoutDefinition(CustomizationContext customizationContext,
LayoutDefinitionId layoutDefinitionId)
Getter for returning a single LayoutDefinition object given a supplied layout
definition identifier. |
LayoutDefinition |
getLayoutDefinitionFromFile(CustomizationContext customizationContext,
String layoutFile,
String webAppName)
Getter for returning a single LayoutDefinition object given a supplied layout
file name and web app name. |
LayoutDefinitionId |
getLayoutDefinitionId(CustomizationContext customizationContext,
String markupName,
String webAppName)
Getter for returning a single LayoutDefinitionId object given a supplied layout
markup name. |
LayoutDefinition[] |
getLayoutDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all LayoutDefinitions scoped to the supplied webapp. |
PageDefinition |
getPageDefinition(CustomizationContext customizationContext,
PageDefinitionId pageDefinitionId)
Getter for returning a single PageDefinition object given a supplied page
definition identifier. |
PageDefinition |
getPageDefinition(CustomizationContext customizationContext,
String pageDefinitionLabel,
String webAppName)
Getter for returning a single PageDefinition object given a supplied page
definition label. |
PageDefinition[] |
getPageDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all PageDefinitions scoped to the supplied webapp. |
PageView |
getPageView(CustomizationContext customizationContext,
PageDefinitionId pageDefinitionId)
Getter for returning an immutable deep copy of a PageView. |
PlaceholderDefinitionId |
getPlaceholderDefinitionId(CustomizationContext customizationContext,
LayoutDefinitionId layoutDefinitionId,
int layoutLocation)
Getter for returning a single PlaceholderDefinitionId object given a supplied placeholder
markup name. |
Placement |
getPlacement(CustomizationContext customizationContext,
PlacementId placementId)
Returns a Placement given a placementId .
|
PageDefinition[] |
getPublicPageDefinitions(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId)
Getter for returning a list of all PageDefinitions marked as public and scoped
scoped to the supplied webapp and not currently on the callers desktop. |
PageDefinition[] |
getPublicPageDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all PageDefinitions marked as public and scoped
scoped to the supplied webapp. |
PageDefinition[] |
getPublicPageDefinitions(CustomizationContext customizationContext,
String webapp,
BookDefinitionId bookDefinitionId)
Getter for returning a list of all PageDefinitions marked as public and scoped
scoped to the supplied webapp and not currently on the the supplied book |
Placement |
movePlaceable(CustomizationContext customizationContext,
PlacementId placementId,
PlaceholderDefinitionId placeholderDefinitionId,
int position)
Move a placeable (book or portlet) definition from one placeholder to another. |
void |
removePlaceable(CustomizationContext customizationContext,
PlacementId placementId)
Remove a placeable from a page's placeholder. |
void |
setSessionContext(SessionContext sessionContext)
|
void |
updateLayoutDefinition(CustomizationContext customizationContext,
LayoutDefinition layoutDefinition)
Update the layout definition with the new data. |
void |
updatePageDefinition(CustomizationContext customizationContext,
PageDefinition pageDefinition)
Update the page definition with the new data. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PageDefinitionManagerImpl()
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 PageView getPageView(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId)
IPageDefinitionManager
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 IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.pageDefinitionId
- the unique pageDefinitionId.
public PageDefinition[] getPageDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
IPageDefinitionManager
Getter for returning a list of all PageDefinitions
scoped to the supplied webapp.
getPageDefinitions
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.webapp
- the web application these page definitions are scoped to.
PageDefinition
objects if they exist, otherwise, an empty array.
RemoteException
PageDefinition
public PageDefinition[] getPublicPageDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
IPageDefinitionManager
Getter for returning a list of all PageDefinitions
marked as public and scoped
scoped to the supplied webapp.
getPublicPageDefinitions
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.webapp
- the web application these page definitions are scoped to.
PageDefinition
objects if they exist, otherwise, an empty array.
RemoteException
PageDefinition
public PageDefinition[] getPublicPageDefinitions(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId) throws RemoteException
IPageDefinitionManager
Getter for returning a list of all PageDefinitions
marked as public and scoped
scoped to the supplied webapp and not currently on the callers desktop.
getPublicPageDefinitions
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.desktopDefinitionId
- you wish to add any of these book definitions to.
PageDefinition
objects if they exist, otherwise, an empty array.
RemoteException
PageDefinition
public PageDefinition[] getPublicPageDefinitions(CustomizationContext customizationContext, String webapp, BookDefinitionId bookDefinitionId) throws RemoteException
IPageDefinitionManager
Getter for returning a list of all PageDefinitions
marked as public and scoped
scoped to the supplied webapp and not currently on the the supplied book
getPublicPageDefinitions
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.webapp
- the web application these page definitions are scoped to.bookDefinitionId
- you wish to add any of these book definitions to.
PageDefinition
objects if they exist, otherwise, an empty array.
RemoteException
PageDefinition
public PageDefinition getPageDefinition(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) throws RemoteException
IPageDefinitionManager
Getter for returning a single PageDefinition
object given a supplied page
definition identifier.
getPageDefinition
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.pageDefinitionId
- the unique page definition identifier.
PageDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
public PageDefinition getPageDefinition(CustomizationContext customizationContext, String pageDefinitionLabel, String webAppName) throws RemoteException
IPageDefinitionManager
Getter for returning a single PageDefinition
object given a supplied page
definition label.
getPageDefinition
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.pageDefinitionLabel
- the unique page definition label.webAppName
- the webapp this page is scoped to.
PageDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
public void deletePageDefinition(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
IPageDefinitionManager
Delete a page definition, but only if it is not used byt other page instances.
deletePageDefinition
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.pageDefinitionId
- the id of the page definition to delete.
ObjectInUseException
- if page instances are currently using this page definition
ObjectNotFoundException
- if the pageDefinitionId is bogus
NotEntitledException
- the caller is not entitled to perform this operation.
RemoteException
IPageDefinitionManager.deletePageDefinitionWithCascade(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.PageDefinitionId)
public void deletePageDefinitionWithReplacement(CustomizationContext customizationContext, PageDefinitionId deletePageDefinitionId, PageDefinitionId replacementPageDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPageDefinitionManager
Delete an existing page definition and if it is in use replace it's use with the supplied page defintion.
Note: all customization of the deleted page will be lost.
deletePageDefinitionWithReplacement
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIddeletePageDefinitionId
- the definition id of the page to deletereplacementPageDefinitionId
- the definition id of the page to replace the deleted page.
ObjectNotFoundException
- if the pageDefinitionId is bogus.
NotEntitledException
- no entitlements for this operation.
RemoteException
PageDefinition
public void deletePageDefinitionWithCascade(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPageDefinitionManager
Delete a page definition and all page instances associated with this definition.
deletePageDefinitionWithCascade
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.pageDefinitionId
- the id of the page definition to delete.
ObjectNotFoundException
- if the pageDefinitionId is bogus
NotEntitledException
- the caller is not entitled to perform this operation.
RemoteException
IPageDefinitionManager.deletePageDefinition(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.PageDefinitionId)
public void updatePageDefinition(CustomizationContext customizationContext, PageDefinition pageDefinition) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPageDefinitionManager
Update the page definition with the new data.
updatePageDefinition
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.pageDefinition
- the page definition containing the new data
ObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.
RemoteException
NotEntitledException
public PlaceableInstance addPlaceable(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId, PlaceableDefinitionId placeableDefinitionId, PlaceholderDefinitionId placeholderDefinitionId, int position) throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException, IllegalDependencyException, DuplicateObjectException
IPageDefinitionManager
addPlaceable
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales.pageDefinitionId
- the id of the page to place the placeable.placeableDefinitionId
- the abstract definition id of the placeable definition.placeholderDefinitionId
- the placehoder to place this placeable in.position
- the position in the placeholder to insert the placeholder.
DuplicateObjectException
- if the navigable is a book and is already added to this page
IllegalDependencyException
- adding the Placeable to the PageDefinition would cause a recursive dependancy
MissingDataException
- the placeableDefinition is missing some vital data.
ObjectNotFoundException
- if the PageDefinitionId or the PlaceholderDefinition Id are bogus
NotEntitledException
- the caller is not entitled to perform this action
RemoteException
public Placement movePlaceable(CustomizationContext customizationContext, PlacementId placementId, PlaceholderDefinitionId placeholderDefinitionId, int position) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPageDefinitionManager
movePlaceable
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales & request.placementId
- the placement id of the placeables current placement within the pageplaceholderDefinitionId
- the new 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
RemoteException
public void removePlaceable(CustomizationContext customizationContext, PlacementId placementId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPageDefinitionManager
Remove a placeable from a page's placeholder. This operation will NOT delete the PageView Definition.
removePlaceable
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.placementId
-
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
public PageDefinition createPageDefinition(CustomizationContext customizationContext, PageDefinition pageDefinition) throws RemoteException, MissingDataException, NotEntitledException
IPageDefinitionManager
createPageDefinition
in interface IPageDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.pageDefinition
- the object containing the data to create the new page definition with.
MissingDataException
- the pade definition object supplied is missing some vital data.
NotEntitledException
- caller is not entitled to perform this action
RemoteException
public LayoutDefinition[] getLayoutDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
ILayoutDefinitionManager
Getter for returning a list of all LayoutDefinitions
scoped to the supplied webapp.
getLayoutDefinitions
in interface ILayoutDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdwebapp
- the web application these layout definitions are scoped to.
LayoutDefinition
objects if they exist, otherwise, an empty array.
RemoteException
LayoutDefinition
public LayoutDefinition getLayoutDefinition(CustomizationContext customizationContext, LayoutDefinitionId layoutDefinitionId) throws RemoteException
ILayoutDefinitionManager
Getter for returning a single LayoutDefinition
object given a supplied layout
definition identifier.
getLayoutDefinition
in interface ILayoutDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdlayoutDefinitionId
- the unique layout definition identifier.
LayoutDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
- See Also:
LayoutDefinition
public LayoutDefinition getLayoutDefinitionFromFile(CustomizationContext customizationContext, String layoutFile, String webAppName) throws RemoteException
ILayoutDefinitionManager
Getter for returning a single LayoutDefinition
object given a supplied layout
file name and web app name.
getLayoutDefinitionFromFile
in interface ILayoutDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdlayoutFile
- the name of the .layout filewebAppName
- the name of the web app as defined in the config.xml
LayoutDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
- See Also:
LayoutDefinition
public LayoutDefinition createLayoutDefinition(CustomizationContext customizationContext, LayoutDefinition layoutDefinition) throws RemoteException, MissingDataException, NotEntitledException
ILayoutDefinitionManager
createLayoutDefinition
in interface ILayoutDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdlayoutDefinition
- the layout data and associated placeholders
MissingDataException
- the layoutDefiniiton supplied as an argument is missing some vital data.
NotEntitledException
- the caller is not entitled to create a new layout.
RemoteException
public void updateLayoutDefinition(CustomizationContext customizationContext, LayoutDefinition layoutDefinition) throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException
ILayoutDefinitionManager
Update the layout definition with the new data.
updateLayoutDefinition
in interface ILayoutDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdlayoutDefinition
- the layout definition containing the new data
MissingDataException
- if layoutDefinition is missing required data.
ObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.
RemoteException
NotEntitledException
public void deleteLayoutDefinition(CustomizationContext customizationContext, LayoutDefinitionId layoutDefinitionId) throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
ILayoutDefinitionManager
Delete a layout definition and all its associated placeholders..
deleteLayoutDefinition
in interface ILayoutDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdlayoutDefinitionId
- the id of the layout definition to delete.
ObjectNotFoundException
- if the layoutDefinitionId is bogus
ObjectInUseException
- if page instances are currently using this layout
NotEntitledException
- the caller is not entitled to perform this operation.
RemoteException
ILayoutDefinitionManager.deleteLayoutDefinitionWithReplacement(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.LayoutDefinitionId, com.bea.netuix.application.identifier.LayoutDefinitionId)
public void deleteLayoutDefinitionWithReplacement(CustomizationContext customizationContext, LayoutDefinitionId deleteLayoutDefinitionId, LayoutDefinitionId replacementLayoutDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
ILayoutDefinitionManager
Delete a layout definition (and its placeholders) and replace any uses of that layout with a replacement layout. This method is useful for deleting a layout that is in use by page instances and not having to delete those page instances.
deleteLayoutDefinitionWithReplacement
in interface ILayoutDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIddeleteLayoutDefinitionId
- the id of the layout definition to delete.replacementLayoutDefinitionId
- the id of the replacement layout
ObjectNotFoundException
- if either of the layoutDefinitionIds are bogus
NotEntitledException
- the caller is not entitled to perform this operation.
RemoteException
ILayoutDefinitionManager.deleteLayoutDefinition(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.LayoutDefinitionId)
public Placement getPlacement(CustomizationContext customizationContext, PlacementId placementId) throws RemoteException
IPageDefinitionManager
Placement
given a placementId
.
Returns a null
if no Placement
matching
placementId
exists.
getPlacement
in interface IPageDefinitionManager
placementId
- placementId for the placement being requested
RemoteException
public PlaceholderDefinitionId getPlaceholderDefinitionId(CustomizationContext customizationContext, LayoutDefinitionId layoutDefinitionId, int layoutLocation) throws RemoteException
ILayoutDefinitionManager
Getter for returning a single PlaceholderDefinitionId
object given a supplied placeholder
markup name.
getPlaceholderDefinitionId
in interface ILayoutDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
RemoteException
public LayoutDefinitionId getLayoutDefinitionId(CustomizationContext customizationContext, String markupName, String webAppName) throws RemoteException
ILayoutDefinitionManager
Getter for returning a single LayoutDefinitionId
object given a supplied layout
markup name.
getLayoutDefinitionId
in interface ILayoutDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdmarkupName
- as supplied on the tag.webAppName
- as defined in the config.xml
RemoteException
|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |