Object
ILayoutDefinitionManager
, IPageDefinitionManager
, SessionBean
Object
PageDefinitionManagerImpl
EnterpriseBean
, ILayoutDefinitionManager
, IPageDefinitionManager
, Serializable
, SessionBean
Constructor Summary |
Method Summary |
public |
|
public |
|
public |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void | |
public void | |
public void | |
public void | |
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public void |
|
public |
|
public void |
|
public void |
|
public void |
|
Methods from class java.lang. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods from class com.bea.netuix.application.manager. |
|
Methods from class javax.ejb. |
ejbActivate, ejbPassivate, ejbRemove, setSessionContext |
Constructor Detail |
public PageDefinitionManagerImpl()
Method Detail |
publicDescription copied fromPlaceableInstance
addPlaceable(CustomizationContext
customizationContext,PageDefinitionId
pageDefinitionId,PlaceableDefinitionId
placeableDefinitionId,PlaceholderDefinitionId
placeholderDefinitionId, int position)
throwsRemoteException
,ObjectNotFoundException
,MissingDataException
,NotEntitledException
,IllegalDependencyException
,DuplicateObjectException
IPageDefinitionManager.addPlaceable(CustomizationContext, PageDefinitionId, PlaceableDefinitionId, PlaceholderDefinitionId, int)
RemoteException
ObjectNotFoundException
MissingDataException
NotEntitledException
IllegalDependencyException
DuplicateObjectException
publicDescription copied fromLayoutDefinition
createLayoutDefinition(CustomizationContext
customizationContext,LayoutDefinition
layoutDefinition)
throwsRemoteException
,MissingDataException
,NotEntitledException
ILayoutDefinitionManager.createLayoutDefinition(CustomizationContext, LayoutDefinition)
RemoteException
MissingDataException
NotEntitledException
publicDescription copied fromPageDefinition
createPageDefinition(CustomizationContext
customizationContext,PageDefinition
pageDefinition)
throwsRemoteException
,MissingDataException
,NotEntitledException
IPageDefinitionManager.createPageDefinition(CustomizationContext, PageDefinition)
RemoteException
MissingDataException
NotEntitledException
public void deleteLayoutDefinition(Description copied fromCustomizationContext
customizationContext,LayoutDefinitionId
layoutDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,ObjectInUseException
,NotEntitledException
ILayoutDefinitionManager.deleteLayoutDefinition(CustomizationContext, LayoutDefinitionId)
Delete a layout definition and all its associated placeholders..
RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException
public void deleteLayoutDefinitionWithReplacement(Description copied fromCustomizationContext
customizationContext,LayoutDefinitionId
deleteLayoutDefinitionId,LayoutDefinitionId
replacementLayoutDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
ILayoutDefinitionManager.deleteLayoutDefinitionWithReplacement(CustomizationContext, LayoutDefinitionId, LayoutDefinitionId)
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.
RemoteException
ObjectNotFoundException
NotEntitledException
public void deletePageDefinition(Description copied fromCustomizationContext
customizationContext,PageDefinitionId
pageDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,ObjectInUseException
,NotEntitledException
IPageDefinitionManager.deletePageDefinition(CustomizationContext, PageDefinitionId)
Delete a page definition, but only if it is not used byt other page instances.
RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException
public void deletePageDefinitionWithCascade(Description copied fromCustomizationContext
customizationContext,PageDefinitionId
pageDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IPageDefinitionManager.deletePageDefinitionWithCascade(CustomizationContext, PageDefinitionId)
Delete a page definition and all page instances associated with this definition.
RemoteException
ObjectNotFoundException
NotEntitledException
public void deletePageDefinitionWithReplacement(Description copied fromCustomizationContext
customizationContext,PageDefinitionId
deletePageDefinitionId,PageDefinitionId
replacementPageDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IPageDefinitionManager.deletePageDefinitionWithReplacement(CustomizationContext, PageDefinitionId, PageDefinitionId)
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.RemoteException
ObjectNotFoundException
NotEntitledException
public void ejbActivate()
throwsEJBException
,RemoteException
EJBException
RemoteException
public void ejbCreate()
throwsCreateException
,RemoteException
CreateException
RemoteException
public void ejbPassivate()
throwsEJBException
,RemoteException
EJBException
RemoteException
public void ejbRemove()
throwsEJBException
,RemoteException
EJBException
RemoteException
publicDescription copied fromLayoutDefinition
getLayoutDefinition(CustomizationContext
customizationContext,LayoutDefinitionId
layoutDefinitionId)
throwsRemoteException
ILayoutDefinitionManager.getLayoutDefinition(CustomizationContext, LayoutDefinitionId)
Getter for returning a single LayoutDefinition
object given a supplied layout
definition identifier.
LayoutDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
publicDescription copied fromLayoutDefinition
getLayoutDefinitionFromFile(CustomizationContext
customizationContext,String
layoutFile,String
webAppName)
throwsRemoteException
ILayoutDefinitionManager.getLayoutDefinitionFromFile(CustomizationContext, String, String)
Getter for returning a single LayoutDefinition
object given a supplied layout
file name and web app name.
LayoutDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
publicDescription copied fromLayoutDefinitionId
getLayoutDefinitionId(CustomizationContext
customizationContext,String
markupName,String
webAppName)
throwsRemoteException
ILayoutDefinitionManager.getLayoutDefinitionId(CustomizationContext, String, String)
Getter for returning a single LayoutDefinitionId
object given a supplied layout
markup name.
RemoteException
publicDescription copied fromLayoutDefinition
[] getLayoutDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
ILayoutDefinitionManager.getLayoutDefinitions(CustomizationContext, String)
Getter for returning a list of all LayoutDefinitions
scoped to the supplied webapp.
LayoutDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromLayoutDefinition
[] getLayoutDefinitions(CustomizationContext
customizationContext,String
webapp,LayoutDefinitionId
firstLayoutDefinitionId, int limit)
throwsRemoteException
ILayoutDefinitionManager.getLayoutDefinitions(CustomizationContext, String, LayoutDefinitionId, int)
Returns LayoutDefinition
s in definitionId
order (create order). Starting
with the supplied definitionId and limiting the result set to size limit
If fewer LayoutDefinition
s exist than limit
,
then a smaller result set will be returned. If no definitions are
found an empty array is returned.
To start at the beginning of the list specify null
as the layoutDefinitionId
.
To retrieve from the end of the list and back specify null
as the layoutDefinitionId
and a negative limit
.
To retrieve all the layoutDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this
method return LayoutDefinition
s in a consistent
order.
LayoutDefinition
s no greater than limit
in size. RemoteException
publicDescription copied fromPageDefinition
getPageDefinition(CustomizationContext
customizationContext,PageDefinitionId
pageDefinitionId)
throwsRemoteException
IPageDefinitionManager.getPageDefinition(CustomizationContext, PageDefinitionId)
Getter for returning a single PageDefinition
object given a supplied page
definition identifier.
PageDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
publicDescription copied fromPageDefinition
getPageDefinition(CustomizationContext
customizationContext,String
pageDefinitionLabel,String
webAppName)
throwsRemoteException
IPageDefinitionManager.getPageDefinition(CustomizationContext, String, String)
Getter for returning a single PageDefinition
object given a supplied page
definition label.
PageDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
publicDescription copied fromPageDefinition
[] getPageDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
IPageDefinitionManager.getPageDefinitions(CustomizationContext, String)
Getter for returning a list of all PageDefinitions
scoped to the supplied webapp.
PageDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromPageDefinition
[] getPageDefinitions(CustomizationContext
customizationContext,String
webapp,PageDefinitionId
firstPageDefinitionId, int limit)
throwsRemoteException
IPageDefinitionManager.getPageDefinitions(CustomizationContext, String, PageDefinitionId, int)
Returns PageDefinition
s in definitionId
order (create order). Starting
with the supplied definitionId and limiting the result set to size limit
If fewer PageDefinition
s exist than limit
,
then a smaller result set will be returned. If no definitions are
found an empty array is returned.
To start at the beginning of the list specify null
as the pageDefinitionId
.
To retrieve from the end of the list and back specify null
as the pageDefinitionId
and a negative limit
.
To retrieve all the pageDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this
method return PageDefinition
s in a consistent
order.
PageDefinition
s no greater than limit
in size. RemoteException
publicDescription copied fromPageView
getPageView(CustomizationContext
customizationContext,PageDefinitionId
pageDefinitionId)
IPageDefinitionManager.getPageView(CustomizationContext, PageDefinitionId)
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.
publicDescription copied fromPlaceholderDefinitionId
getPlaceholderDefinitionId(CustomizationContext
customizationContext,LayoutDefinitionId
layoutDefinitionId, int layoutLocation)
throwsRemoteException
ILayoutDefinitionManager.getPlaceholderDefinitionId(CustomizationContext, LayoutDefinitionId, int)
Getter for returning a single PlaceholderDefinitionId
object given a supplied placeholder
markup name.
RemoteException
publicDescription copied fromPlacement
getPlacement(CustomizationContext
customizationContext,PlacementId
placementId)
throwsRemoteException
IPageDefinitionManager.getPlacement(CustomizationContext, PlacementId)
Placement
given a placementId
.
Returns a null
if no Placement
matching
placementId
exists.
RemoteException
publicDescription copied fromPageDefinition
[] getPublicPageDefinitions(CustomizationContext
customizationContext,String
webapp,PageDefinitionId
firstPageDefinitionId, int limit)
throwsRemoteException
IPageDefinitionManager.getPublicPageDefinitions(CustomizationContext, String, PageDefinitionId, int)
Returns PageDefinition
s in definitionId
order (create order) marked as public
and scoped to the supplied webapp. Starting
with the supplied definitionId and limiting the result set to size limit
If fewer PageDefinition
s exist than limit
,
then a smaller result set will be returned. If no definitions are
found an empty array is returned.
To start at the beginning of the list specify null
as the pageDefinitionId
.
To retrieve from the end of the list and back specify null
as the pageDefinitionId
and a negative limit
.
To retrieve all the pageDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this
method return PageDefinition
s in a consistent
order.
PageDefinition
s no greater than limit
in size. RemoteException
publicDescription copied fromPageDefinition
[] getPublicPageDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
IPageDefinitionManager.getPublicPageDefinitions(CustomizationContext, String)
Getter for returning a list of all PageDefinitions
marked as public and scoped
to the supplied webapp.
PageDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromPageDefinition
[] getPublicPageDefinitions(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId)
throwsRemoteException
IPageDefinitionManager.getPublicPageDefinitions(CustomizationContext, 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
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromPageDefinition
[] getPublicPageDefinitions(CustomizationContext
customizationContext,String
webapp,BookDefinitionId
bookDefinitionId)
throwsRemoteException
IPageDefinitionManager.getPublicPageDefinitions(CustomizationContext, String, 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
PageDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromPlacement
movePlaceable(CustomizationContext
customizationContext,PlacementId
placementId,PlaceholderDefinitionId
placeholderDefinitionId, int position)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IPageDefinitionManager.movePlaceable(CustomizationContext, PlacementId, PlaceholderDefinitionId, int)
RemoteException
ObjectNotFoundException
NotEntitledException
public void removePlaceable(Description copied fromCustomizationContext
customizationContext,PlacementId
placementId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IPageDefinitionManager.removePlaceable(CustomizationContext, PlacementId)
Remove a placeable from a page's placeholder. This operation will NOT delete the PageView Definition.
RemoteException
ObjectNotFoundException
NotEntitledException
publicDescription copied fromPageDefinition
[] searchPublicPageDefinitions(CustomizationContext
customizationContext,String
webapp,String
title, int limit)
throwsRemoteException
IPageDefinitionManager.searchPublicPageDefinitions(CustomizationContext, String, String, int)
Search for public pages given the supplied search string. Pages with titles
matching the supplied pattern will be returned.
No more than limit
results will be returned, however a smaller number may be
returned.
Implementation has to ensure that repeated calls to this
method return PageDefinition
s in a consistent
order.
PageDefinition
s no greater than limit
in size. RemoteException
public void setSessionContext(SessionContext
sessionContext)
throwsEJBException
,RemoteException
EJBException
RemoteException
public void updateLayoutDefinition(Description copied fromCustomizationContext
customizationContext,LayoutDefinition
layoutDefinition)
throwsRemoteException
,ObjectNotFoundException
,MissingDataException
,NotEntitledException
ILayoutDefinitionManager.updateLayoutDefinition(CustomizationContext, LayoutDefinition)
Update the layout definition with the new data.
RemoteException
ObjectNotFoundException
MissingDataException
NotEntitledException
public void updatePageDefinition(Description copied fromCustomizationContext
customizationContext,PageDefinition
pageDefinition)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IPageDefinitionManager.updatePageDefinition(CustomizationContext, PageDefinition)
Update the page definition with the new data.
RemoteException
ObjectNotFoundException
NotEntitledException