|
© 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.BookDefinitionManagerImpl
Field Summary | |
protected static Debug |
debug
|
Constructor Summary | |
BookDefinitionManagerImpl()
|
Method Summary | |
NavigableInstance |
addNavigable(CustomizationContext customizationContext,
BookDefinitionId bookDefinitionId,
NavigableDefinitionId navigableDefinitionId,
int position,
int alignment,
boolean isDefault)
Add a Navigable definition (BookDefinition or PageDefinition) to an existing BookDefinition. |
BookDefinition |
createBookDefinition(CustomizationContext customizationContext,
BookDefinition bookDefinition)
Create a new book definition. |
MenuDefinition |
createMenuDefinition(CustomizationContext customizationContext,
MenuDefinition menuDefinition)
Creates a new MenuView Definition with its placeholders. |
void |
deleteBookDefinition(CustomizationContext customizationContext,
BookDefinitionId bookDefinitionId)
Methof for deleting a BookDefinition object given a supplied book
definition identifier. |
void |
deleteBookDefinitionWithCascade(CustomizationContext customizationContext,
BookDefinitionId bookDefinitionId)
Delete the BookDefinition of the supplied book definition identifier and
and all BookInstance objects associated with this book definition. |
void |
deleteBookDefinitionWithReplacement(CustomizationContext customizationContext,
BookDefinitionId deleteBookDefinitionId,
BookDefinitionId replacementBookDefinitionId)
Delete an existing book definition and if it is in use replace it's use with thesupplied book defintion. |
void |
deleteMenuDefinition(CustomizationContext customizationContext,
MenuDefinitionId menuDefinitionId)
Delete a menu definition. |
void |
deleteMenuDefinitionWithReplacement(CustomizationContext customizationContext,
MenuDefinitionId deleteMenuDefinitionId,
MenuDefinitionId replacementMenuDefinitionId)
Delete a menu definition and replace any uses of that menu with a replacement menu. |
void |
ejbActivate()
|
void |
ejbCreate()
|
void |
ejbPassivate()
|
void |
ejbRemove()
|
BookDefinition |
getBookDefinition(CustomizationContext customizationContext,
BookDefinitionId bookDefinitionId)
Getter for returning a single BookDefinition object given a supplied book
definition identifier. |
BookDefinition |
getBookDefinition(CustomizationContext customizationContext,
String definitionLabel,
String webAppName)
Getter for returning a single BookDefinition object given a supplied book
definition label. |
BookDefinition[] |
getBookDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all BookDefinitions scoped to the supplied webapp. |
BookView |
getBookView(CustomizationContext customizationContext,
BookDefinitionId bookDefinitionId)
Getter for returning an immutable deep copy of a BookView. |
MenuDefinition |
getMenuDefinition(CustomizationContext customizationContext,
MenuDefinitionId menuDefinitionId)
Getter for returning a single MenuDefinition object given a supplied menu
definition identifier. |
MenuDefinition |
getMenuDefinitionFromFile(CustomizationContext customizationContext,
String menuFile,
String webAppName)
Getter for returning a single MenuDefinition object given a supplied menu
definition identifier. |
MenuDefinitionId |
getMenuDefinitionId(CustomizationContext customizationContext,
String markupName,
String webAppName)
Getter for returning a single MenuDefinitionId object given a supplied menu
markup name. |
MenuDefinition[] |
getMenuDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all MenuDefinitions scoped to the supplied webapp. |
MenuView |
getMenuView(CustomizationContext customizationContext,
MenuDefinitionId menuDefinitionId)
Getter for returning an immutable deep copy of a MenuView. |
BookDefinition[] |
getPublicBookDefinitions(CustomizationContext customizationContext,
DesktopDefinitionId 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[] |
getPublicBookDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all BookDefinitions scoped to the supplied webapp
and marked as public. |
BookDefinition[] |
getPublicBookDefinitions(CustomizationContext customizationContext,
String webapp,
BookDefinitionId 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[] |
getPublicBookDefinitions(CustomizationContext customizationContext,
String webapp,
PageDefinitionId 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). |
NavigableDefinition |
moveNavigable(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
BookDefinitionId fromParentBookDefinitionId,
BookDefinitionId toParentBookDefinitionId,
NavigableDefinitionId navigableDefinitionId,
int position,
int alignment)
Relocate the navigable definition to a new location. |
void |
removeNavigable(CustomizationContext customizationContext,
BookGroupId bookGroupId)
Remove a NavigableDefinition (BookDefinition or PageDefinition) from the specified book. |
void |
setDefaultNavigable(CustomizationContext customizationContext,
BookDefinitionId parentBookDefinitionId,
NavigableDefinitionId navigableDefinitionId)
Set a navigable (book or page) on a parent page as the default page. |
void |
setSessionContext(SessionContext sessionContext)
|
void |
updateBookDefinition(CustomizationContext customizationContext,
BookDefinition bookDefinition)
Update the persistent store for the supplied BookDefinition . |
void |
updateMenuDefinition(CustomizationContext customizationContext,
MenuDefinition menuDefinition)
Update the menu definition with the new data. |
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 BookDefinitionManagerImpl()
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 BookView getBookView(CustomizationContext customizationContext, BookDefinitionId bookDefinitionId)
IBookDefinitionManager
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.
getBookView
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId.bookDefinitionId
- the unique bookDefinitionId.
IBookInstanceManager.getBookView(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId, com.bea.netuix.application.identifier.BookInstanceId)
public BookDefinition[] getBookDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
IBookDefinitionManager
Getter for returning a list of all BookDefinitions
scoped to the supplied webapp.
getBookDefinitions
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdwebapp
- the web application these book definitions are scoped to.
BookDefinition
objects if they exist, otherwise, an empty array.
RemoteException
BookDefinition
public BookDefinition[] getPublicBookDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
IBookDefinitionManager
Getter for returning a list of all BookDefinitions
scoped to the supplied webapp
and marked as public.
getPublicBookDefinitions
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdwebapp
- the web application these book definitions are scoped to.
BookDefinition
objects if they exist, otherwise, an empty array.
RemoteException
BookDefinition
public BookDefinition[] getPublicBookDefinitions(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId) throws RemoteException
IBookDefinitionManager
Getter for returning a list of all BookDefinitions
scoped to the supplied webapp
and marked as public and not currently on the users desktop.
getPublicBookDefinitions
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIddesktopDefinitionId
- you wish to add any of these book definitions to.
BookDefinition
objects if they exist, otherwise, an empty array.
RemoteException
BookDefinition
public BookDefinition[] getPublicBookDefinitions(CustomizationContext customizationContext, String webapp, PageDefinitionId pageDefinitionId) throws RemoteException
IBookDefinitionManager
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).
getPublicBookDefinitions
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdwebapp
- the web application these book definitions are scoped to.pageDefinitionId
- you wish to add any of these book definitions to.
BookDefinition
objects if they exist, otherwise, an empty array.
RemoteException
BookDefinition
public BookDefinition[] getPublicBookDefinitions(CustomizationContext customizationContext, String webapp, BookDefinitionId bookDefinitionId) throws RemoteException
IBookDefinitionManager
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).
getPublicBookDefinitions
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdwebapp
- the web application these book definitions are scoped to.bookDefinitionId
- you wish to add any of these book definitions to.
BookDefinition
objects if they exist, otherwise, an empty array.
RemoteException
BookDefinition
public BookDefinition getBookDefinition(CustomizationContext customizationContext, BookDefinitionId bookDefinitionId) throws RemoteException
IBookDefinitionManager
Getter for returning a single BookDefinition
object given a supplied book
definition identifier.
getBookDefinition
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdbookDefinitionId
- the unique book definition identifier.
BookDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
- See Also:
BookDefinition
public BookDefinition getBookDefinition(CustomizationContext customizationContext, String definitionLabel, String webAppName) throws RemoteException
IBookDefinitionManager
Getter for returning a single BookDefinition
object given a supplied book
definition label.
getBookDefinition
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIddefinitionLabel
- the unique book definition identifier.webAppName
- the webapp this book is scoped to.
BookDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
- See Also:
BookDefinition
public void deleteBookDefinition(CustomizationContext customizationContext, BookDefinitionId bookDefinitionId) throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
IBookDefinitionManager
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.
deleteBookDefinition
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdbookDefinitionId
- the unique book definition identifier.
ObjectInUseException
- if the book definition is in use by end users.
NotEntitledException
- no entitlements for this operation.
ObjectNotFoundException
- if the bookDefinitionId is bogus.
RemoteException
BookDefinition
public void deleteBookDefinitionWithReplacement(CustomizationContext customizationContext, BookDefinitionId deleteBookDefinitionId, BookDefinitionId replacementBookDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IBookDefinitionManager
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.
deleteBookDefinitionWithReplacement
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIddeleteBookDefinitionId
- the definition id of the book to deletereplacementBookDefinitionId
- the definition id of the book to replace the deleted book.
NotEntitledException
- no entitlements for this operation.
ObjectNotFoundException
- if the bookDefinitionId is bogus.
RemoteException
BookDefinition
public void deleteBookDefinitionWithCascade(CustomizationContext customizationContext, BookDefinitionId bookDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException, ObjectInUseException
IBookDefinitionManager
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().
deleteBookDefinitionWithCascade
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdbookDefinitionId
- the unique book definition identifier of the book to delete.
ObjectInUseException
- if the book definition is the main book on a desktop.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
ObjectNotFoundException
- if there is no BookDefinition associated with bookDefinitionId.
RemoteException
public void updateBookDefinition(CustomizationContext customizationContext, BookDefinition bookDefinition) throws RemoteException, ObjectNotFoundException, NotEntitledException
IBookDefinitionManager
Update the persistent store for the supplied BookDefinition
. All attributes of the BookDefinition
are updated in persistent store.
updateBookDefinition
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdbookDefinition
- the object containing the new data for the book definition.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
ObjectNotFoundException
- the BookDefinitionId
RemoteException
public NavigableInstance addNavigable(CustomizationContext customizationContext, BookDefinitionId bookDefinitionId, NavigableDefinitionId navigableDefinitionId, int position, int alignment, boolean isDefault) throws RemoteException, ObjectNotFoundException, NotEntitledException, IllegalDependencyException, DuplicateObjectException
IBookDefinitionManager
Add a Navigable definition (BookDefinition or PageDefinition) to an existing BookDefinition.
addNavigable
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdbookDefinitionId
- the book definition to add the navigable to.navigableDefinitionId
- the definition id of the navigable defintion from which to add.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)
DuplicateObjectException
- if this navigable is already added to this book
IllegalDependencyException
- adding the Navigable to the BookDefinition would cause a recursive dependancy
NotEntitledException
- if the caller does not have the required permissions to delete this object.
ObjectNotFoundException
- BookDefinitionId or the NavigableDefinitionId are bogus.
RemoteException
NavigableView.ALIGNMENT_LEFT
,
NavigableView.ALIGNMENT_RIGHT
public NavigableDefinition moveNavigable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, BookDefinitionId fromParentBookDefinitionId, BookDefinitionId toParentBookDefinitionId, NavigableDefinitionId navigableDefinitionId, int position, int alignment) throws RemoteException, ObjectNotFoundException, NotEntitledException
IBookDefinitionManager
Relocate the navigable definition to a new location.
moveNavigable
in interface IBookDefinitionManager
desktopDefinitionId
- the desktop context to which this update applies.fromParentBookDefinitionId
- the parent book definition id we are moving this navigable from.toParentBookDefinitionId
- the parent book definition to move the navigable definition to.navigableDefinitionId
- the identifier identifying the definition 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.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
ObjectNotFoundException
- BookDefinitionId or the NavigableDefinitionId are bogus.
RemoteException
public void removeNavigable(CustomizationContext customizationContext, BookGroupId bookGroupId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IBookDefinitionManager
Remove a NavigableDefinition (BookDefinition or PageDefinition) from the specified book. This method does not delete the NavigableDefintion it just removes it from the book.
removeNavigable
in interface IBookDefinitionManager
bookGroupId
- the book group id of the navigable to be removed.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
ObjectNotFoundException
- if the navigable or book definition could not be found in persistent store.
RemoteException
public void setDefaultNavigable(CustomizationContext customizationContext, BookDefinitionId parentBookDefinitionId, NavigableDefinitionId navigableDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IBookDefinitionManager
Set a navigable (book or page) on a parent page as the default page.
setDefaultNavigable
in interface IBookDefinitionManager
parentBookDefinitionId
- the book definition id of the parent booknavigableDefinitionId
- the child book or page definition id to become the new defualt page
NotEntitledException
- if the caller does not have the required permissions to delete this object.
ObjectNotFoundException
- if the navigable or book definition could not be found in persistent store.
RemoteException
public BookDefinition createBookDefinition(CustomizationContext customizationContext, BookDefinition bookDefinition) throws RemoteException, MissingDataException, NotEntitledException
IBookDefinitionManager
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.
createBookDefinition
in interface IBookDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdbookDefinition
- the book definition object containing all the required data.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
MissingDataException
- if some vital information is missing from the BookDefinition.
RemoteException
public MenuView getMenuView(CustomizationContext customizationContext, MenuDefinitionId menuDefinitionId) throws RemoteException
IMenuDefinitionManager
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.
getMenuView
in interface IMenuDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuDefinitionId
- the unique menuDefinitionId.
RemoteException
public MenuDefinition[] getMenuDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
IMenuDefinitionManager
Getter for returning a list of all MenuDefinitions
scoped to the supplied webapp.
getMenuDefinitions
in interface IMenuDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdwebapp
- the web application these menu definitions are scoped to.
MenuDefinition
objects if they exist, otherwise, an empty array.
RemoteException
MenuDefinition
public MenuDefinition getMenuDefinition(CustomizationContext customizationContext, MenuDefinitionId menuDefinitionId) throws RemoteException
IMenuDefinitionManager
Getter for returning a single MenuDefinition
object given a supplied menu
definition identifier.
getMenuDefinition
in interface IMenuDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuDefinitionId
- the unique menu definition identifier.
MenuDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
- See Also:
MenuDefinition
public MenuDefinition getMenuDefinitionFromFile(CustomizationContext customizationContext, String menuFile, String webAppName) throws RemoteException
IMenuDefinitionManager
Getter for returning a single MenuDefinition
object given a supplied menu
definition identifier.
getMenuDefinitionFromFile
in interface IMenuDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuFile
- the name of the .menu filewebAppName
- the name of the webapp as defined in the config.xml
MenuDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
- See Also:
MenuDefinition
public MenuDefinition createMenuDefinition(CustomizationContext customizationContext, MenuDefinition menuDefinition) throws RemoteException, MissingDataException, NotEntitledException
IMenuDefinitionManager
createMenuDefinition
in interface IMenuDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuDefinition
- the menu data and associated placeholders
NotEntitledException
- the caller is not entitled to create a new menu.
MissingDataException
- the menuDefiniiton supplied as an argument is missing some vital data.
RemoteException
public void updateMenuDefinition(CustomizationContext customizationContext, MenuDefinition menuDefinition) throws RemoteException, ObjectNotFoundException, NotEntitledException
IMenuDefinitionManager
Update the menu definition with the new data.
updateMenuDefinition
in interface IMenuDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuDefinition
- the menu definition containing the new data
ObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.
RemoteException
NotEntitledException
public void deleteMenuDefinition(CustomizationContext customizationContext, MenuDefinitionId menuDefinitionId) throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
IMenuDefinitionManager
Delete a menu definition.
deleteMenuDefinition
in interface IMenuDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuDefinitionId
- the id of the menu definition to delete.
NotEntitledException
- the caller is not entitled to perform this operation.
ObjectInUseException
- if page instances are currently using this menu
ObjectNotFoundException
- if the menuDefinitionId is bogus
RemoteException
IMenuDefinitionManager.deleteMenuDefinitionWithReplacement(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.MenuDefinitionId, com.bea.netuix.application.identifier.MenuDefinitionId)
public void deleteMenuDefinitionWithReplacement(CustomizationContext customizationContext, MenuDefinitionId deleteMenuDefinitionId, MenuDefinitionId replacementMenuDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IMenuDefinitionManager
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.
deleteMenuDefinitionWithReplacement
in interface IMenuDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIddeleteMenuDefinitionId
- the id of the menu definition to delete.replacementMenuDefinitionId
- the id of the replacement menu
NotEntitledException
- the caller is not entitled to perform this operation.
ObjectNotFoundException
- if either of the menuDefinitionIds are bogus
RemoteException
IMenuDefinitionManager.deleteMenuDefinition(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.MenuDefinitionId)
public MenuDefinitionId getMenuDefinitionId(CustomizationContext customizationContext, String markupName, String webAppName) throws RemoteException
IMenuDefinitionManager
Getter for returning a single MenuDefinitionId
object given a supplied menu
markup name.
getMenuDefinitionId
in interface IMenuDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceIdmarkupName
- the markup name attribute 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 |