Object
IBookDefinitionManager
, IMenuDefinitionManager
, SessionBean
Object
BookDefinitionManagerImpl
EnterpriseBean
, IBookDefinitionManager
, IMenuDefinitionManager
, Serializable
, SessionBean
Field Summary |
protected static |
|
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 |
|
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 |
Field Detail |
protected static Debug
debug
Constructor Detail |
public BookDefinitionManagerImpl()
Method Detail |
publicDescription copied fromNavigableInstance
addNavigable(CustomizationContext
customizationContext,BookDefinitionId
bookDefinitionId,NavigableDefinitionId
navigableDefinitionId, int position, int alignment, boolean isDefault)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
,IllegalDependencyException
,DuplicateObjectException
IBookDefinitionManager.addNavigable(CustomizationContext, BookDefinitionId, NavigableDefinitionId, int, int, boolean)
Add a Navigable definition (BookDefinition or PageDefinition) to an existing BookDefinition.
RemoteException
ObjectNotFoundException
NotEntitledException
IllegalDependencyException
DuplicateObjectException
publicDescription copied fromBookDefinition
createBookDefinition(CustomizationContext
customizationContext,BookDefinition
bookDefinition)
throwsRemoteException
,MissingDataException
,NotEntitledException
IBookDefinitionManager.createBookDefinition(CustomizationContext, BookDefinition)
Create a new book definition. Creates a new book definition in the persistent store. This definition may be used to create book instance later on.
RemoteException
MissingDataException
NotEntitledException
publicDescription copied fromMenuDefinition
createMenuDefinition(CustomizationContext
customizationContext,MenuDefinition
menuDefinition)
throwsRemoteException
,MissingDataException
,NotEntitledException
IMenuDefinitionManager.createMenuDefinition(CustomizationContext, MenuDefinition)
RemoteException
MissingDataException
NotEntitledException
public void deleteBookDefinition(Description copied fromCustomizationContext
customizationContext,BookDefinitionId
bookDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,ObjectInUseException
,NotEntitledException
IBookDefinitionManager.deleteBookDefinition(CustomizationContext, BookDefinitionId)
Methof for deleting a BookDefinition
object given a supplied book
definition identifier. If the BookDefinition is in use by clients then a
ObjectInUseFound
exception is thrown.
RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException
public void deleteBookDefinitionWithCascade(Description copied fromCustomizationContext
customizationContext,BookDefinitionId
bookDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
,ObjectInUseException
IBookDefinitionManager.deleteBookDefinitionWithCascade(CustomizationContext, BookDefinitionId)
Delete the BookDefinition
of the supplied book definition identifier and
and all BookInstance
objects associated with this book definition. While this method
will cascade delete all the user's and admin's customizations it will complain (ObjectInUseException)
if the definition is the primary book of a desktop. In that case you may want to try
deleteBookDefinitionWithReplacement().
RemoteException
ObjectNotFoundException
NotEntitledException
ObjectInUseException
public void deleteBookDefinitionWithReplacement(Description copied fromCustomizationContext
customizationContext,BookDefinitionId
deleteBookDefinitionId,BookDefinitionId
replacementBookDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IBookDefinitionManager.deleteBookDefinitionWithReplacement(CustomizationContext, BookDefinitionId, BookDefinitionId)
Delete an existing book definition and if it is in use replace it's use with thesupplied book defintion.
Note all customization of the deleted book will be lost.RemoteException
ObjectNotFoundException
NotEntitledException
public void deleteMenuDefinition(Description copied fromCustomizationContext
customizationContext,MenuDefinitionId
menuDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,ObjectInUseException
,NotEntitledException
IMenuDefinitionManager.deleteMenuDefinition(CustomizationContext, MenuDefinitionId)
Delete a menu definition.
RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException
public void deleteMenuDefinitionWithReplacement(Description copied fromCustomizationContext
customizationContext,MenuDefinitionId
deleteMenuDefinitionId,MenuDefinitionId
replacementMenuDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IMenuDefinitionManager.deleteMenuDefinitionWithReplacement(CustomizationContext, MenuDefinitionId, MenuDefinitionId)
Delete a menu definition and replace any uses of that menu with a replacement menu. This method is useful for deleting a menu that is in use by book instances and not having to delete those book instances.
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 fromBookDefinition
getBookDefinition(CustomizationContext
customizationContext,BookDefinitionId
bookDefinitionId)
throwsRemoteException
IBookDefinitionManager.getBookDefinition(CustomizationContext, BookDefinitionId)
Getter for returning a single BookDefinition
object given a supplied book
definition identifier.
BookDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
publicDescription copied fromBookDefinition
getBookDefinition(CustomizationContext
customizationContext,String
definitionLabel,String
webAppName)
throwsRemoteException
IBookDefinitionManager.getBookDefinition(CustomizationContext, String, String)
Getter for returning a single BookDefinition
object given a supplied book
definition label.
BookDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
publicDescription copied fromBookDefinition
[] getBookDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
IBookDefinitionManager.getBookDefinitions(CustomizationContext, String)
Getter for returning a list of all BookDefinitions
scoped to the supplied webapp.
BookDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromBookDefinition
[] getBookDefinitions(CustomizationContext
customizationContext,String
webapp,BookDefinitionId
bookDefinitionId, int limit)
throwsRemoteException
IBookDefinitionManager.getBookDefinitions(CustomizationContext, String, BookDefinitionId, int)
Returns BookDefinition
s in definitionId
order (create order). Starting
with the supplied definitionId and limiting the result set to size limit
If fewer BookDefinition
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 bookDefinitionId
.
To retrieve from the end of the list and back specify null
as the bookDefinitionId
and a negative limit
.
To retrieve all the bookDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this
method return BookDefinition
s in a consistent
order.
BookDefinition
s no greater than limit
in size. RemoteException
publicDescription copied fromBookView
getBookView(CustomizationContext
customizationContext,BookDefinitionId
bookDefinitionId)
IBookDefinitionManager.getBookView(CustomizationContext, BookDefinitionId)
Getter for returning an immutable deep copy of a BookView. The BookView
object, unlike the BookDefinition
or the BookInstance
objects
contains a full set of references to all child pages, books and so on. The
BookView
object however is immutable.
publicDescription copied fromMenuDefinition
getMenuDefinition(CustomizationContext
customizationContext,MenuDefinitionId
menuDefinitionId)
throwsRemoteException
IMenuDefinitionManager.getMenuDefinition(CustomizationContext, MenuDefinitionId)
Getter for returning a single MenuDefinition
object given a supplied menu
definition identifier.
MenuDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
publicDescription copied fromMenuDefinition
getMenuDefinitionFromFile(CustomizationContext
customizationContext,String
menuFile,String
webAppName)
throwsRemoteException
IMenuDefinitionManager.getMenuDefinitionFromFile(CustomizationContext, String, String)
Getter for returning a single MenuDefinition
object given a supplied menu
definition identifier.
MenuDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
publicDescription copied fromMenuDefinitionId
getMenuDefinitionId(CustomizationContext
customizationContext,String
markupName,String
webAppName)
throwsRemoteException
IMenuDefinitionManager.getMenuDefinitionId(CustomizationContext, String, String)
Getter for returning a single MenuDefinitionId
object given a supplied menu
markup name.
RemoteException
publicDescription copied fromMenuDefinition
[] getMenuDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
IMenuDefinitionManager.getMenuDefinitions(CustomizationContext, String)
Getter for returning a list of all MenuDefinitions
scoped to the supplied webapp.
MenuDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromMenuDefinition
[] getMenuDefinitions(CustomizationContext
customizationContext,String
webapp,MenuDefinitionId
menuDefinitionId, int limit)
throwsRemoteException
IMenuDefinitionManager.getMenuDefinitions(CustomizationContext, String, MenuDefinitionId, int)
Returns MenuDefinition
s in definitionId
order (create order). Starting
with the supplied definitionId and limiting the result set to size limit
If fewer MenuDefinition
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 menuDefinitionId
.
To retrieve from the end of the list and back specify null
as the menuDefinitionId
and a negative limit
.
To retrieve all the menuDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this
method return MenuDefinition
s in a consistent
order.
MenuDefinition
s no greater than limit
in size. RemoteException
publicDescription copied fromMenuView
getMenuView(CustomizationContext
customizationContext,MenuDefinitionId
menuDefinitionId)
throwsRemoteException
IMenuDefinitionManager.getMenuView(CustomizationContext, MenuDefinitionId)
Getter for returning an immutable deep copy of a MenuView. The MenuView
object, unlike the MenuDefinition
or the MenuInstance
objects
contains a full set of references to all child pages, menus and so on. The
MenuView
object however is immutable.
RemoteException
publicDescription copied fromBookDefinition
[] getPublicBookDefinitions(CustomizationContext
customizationContext,String
webapp,BookDefinitionId
bookDefinitionId, int limit)
throwsRemoteException
IBookDefinitionManager.getPublicBookDefinitions(CustomizationContext, String, BookDefinitionId, int)
Returns BookDefinition
s in definitionId
order (create order) scoped to the supplied webapp
and marked as public. Starting with the supplied definitionId and limiting the result set to size limit
If fewer BookDefinition
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 bookDefinitionId
.
To retrieve from the end of the list and back specify null
as the bookDefinitionId
and a negative limit
.
To retrieve all the bookDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this
method return BookDefinition
s in a consistent
order.
BookDefinition
s no greater than limit
in size. RemoteException
publicDescription copied fromBookDefinition
[] getPublicBookDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
IBookDefinitionManager.getPublicBookDefinitions(CustomizationContext, String)
Getter for returning a list of all BookDefinitions
scoped to the supplied webapp
and marked as public.
BookDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromBookDefinition
[] getPublicBookDefinitions(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId)
throwsRemoteException
IBookDefinitionManager.getPublicBookDefinitions(CustomizationContext, DesktopDefinitionId)
Getter for returning a list of all BookDefinitions
scoped to the supplied webapp
and marked as public and not currently on the users desktop.
BookDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromBookDefinition
[] getPublicBookDefinitions(CustomizationContext
customizationContext,String
webapp,PageDefinitionId
pageDefinitionId)
throwsRemoteException
IBookDefinitionManager.getPublicBookDefinitions(CustomizationContext, String, PageDefinitionId)
Getter for returning a list of all BookDefinitions
scoped to the supplied webapp
and marked as public aand not currently in the supplied page (pageDefinitionId).
BookDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromBookDefinition
[] getPublicBookDefinitions(CustomizationContext
customizationContext,String
webapp,BookDefinitionId
bookDefinitionId)
throwsRemoteException
IBookDefinitionManager.getPublicBookDefinitions(CustomizationContext, String, BookDefinitionId)
Getter for returning a list of all BookDefinitions
scoped to the supplied webapp
and marked as public and not currently in the supplied book (bookDefinitionId).
BookDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromNavigableDefinition
moveNavigable(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,BookDefinitionId
fromParentBookDefinitionId,BookDefinitionId
toParentBookDefinitionId,NavigableDefinitionId
navigableDefinitionId, int position, int alignment)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IBookDefinitionManager.moveNavigable(CustomizationContext, DesktopDefinitionId, BookDefinitionId, BookDefinitionId, NavigableDefinitionId, int, int)
Relocate the navigable definition to a new location.
RemoteException
ObjectNotFoundException
NotEntitledException
public void removeNavigable(Description copied fromCustomizationContext
customizationContext,BookGroupId
bookGroupId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IBookDefinitionManager.removeNavigable(CustomizationContext, BookGroupId)
Remove a NavigableDefinition (BookDefinition or PageDefinition) from the specified book. This method does not delete the NavigableDefintion it just removes it from the book.
RemoteException
ObjectNotFoundException
NotEntitledException
publicDescription copied fromBookDefinition
[] searchPublicBookDefinitions(CustomizationContext
customizationContext,String
webapp,String
title, int limit)
throwsRemoteException
IBookDefinitionManager.searchPublicBookDefinitions(CustomizationContext, String, String, int)
Search for public books given the supplied search string. Books 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 BookDefinition
s in a consistent
order.
BookDefinition
s no greater than limit
in size. RemoteException
public void setDefaultNavigable(Description copied fromCustomizationContext
customizationContext,BookDefinitionId
parentBookDefinitionId,NavigableDefinitionId
navigableDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IBookDefinitionManager.setDefaultNavigable(CustomizationContext, BookDefinitionId, NavigableDefinitionId)
Set a navigable (book or page) on a parent page as the default page.
RemoteException
ObjectNotFoundException
NotEntitledException
public void setSessionContext(SessionContext
sessionContext)
throwsEJBException
,RemoteException
EJBException
RemoteException
public void updateBookDefinition(Description copied fromCustomizationContext
customizationContext,BookDefinition
bookDefinition)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IBookDefinitionManager.updateBookDefinition(CustomizationContext, BookDefinition)
Update the persistent store for the supplied BookDefinition
. All attributes of the BookDefinition
are updated in persistent store.
RemoteException
ObjectNotFoundException
NotEntitledException
public void updateMenuDefinition(Description copied fromCustomizationContext
customizationContext,MenuDefinition
menuDefinition)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IMenuDefinitionManager.updateMenuDefinition(CustomizationContext, MenuDefinition)
Update the menu definition with the new data.
RemoteException
ObjectNotFoundException
NotEntitledException