|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is the primary interface for performing persistent store operations
on MenuDefinitions
. In general this interface provides coarse grain
getters and fine grain setters.
It is important to note that all methods on this interface are fully internationalized and entitled. All titles and descriptions on the objects returned by these methods are internationalized to the prefered locale. Also, all methods are entitled, meaning if the caller does not have the required credentials the method may return a subset of the actual list or be unable to perform the specified function.
Method Summary | |
MenuDefinition |
createMenuDefinition(CustomizationContext customizationContext,
MenuDefinition menuDefinition)
Creates a new MenuView Definition with its placeholders. |
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. |
MenuDefinition |
getMenuDefinition(CustomizationContext customizationContext,
MenuDefinitionId menuDefinitionId)
Getter for returning a single MenuDefinition object given a supplied menu
definition identifier. |
MenuDefinition |
getMenuDefinitionFromFile(CustomizationContext customizationContext,
String menuFileName,
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. |
void |
updateMenuDefinition(CustomizationContext customizationContext,
MenuDefinition menuDefinition)
Update the menu definition with the new data. |
Method Detail |
public MenuView getMenuView(CustomizationContext customizationContext, MenuDefinitionId menuDefinitionId) throws RemoteException
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.
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuDefinitionId
- the unique menuDefinitionId.
RemoteException
public MenuDefinition[] getMenuDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
Getter for returning a list of all MenuDefinitions
scoped to the supplied webapp.
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
Getter for returning a single MenuDefinition
object given a supplied menu
definition identifier.
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 menuFileName, String webAppName) throws RemoteException
Getter for returning a single MenuDefinition
object given a supplied menu
definition identifier.
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuFileName
- 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
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuDefinition
- the menu data and associated placeholders
MissingDataException
- the menuDefiniiton supplied as an argument is missing some vital data.
NotEntitledException
- the caller is not entitled to create a new menu.
RemoteException
public void updateMenuDefinition(CustomizationContext customizationContext, MenuDefinition menuDefinition) throws RemoteException, ObjectNotFoundException, NotEntitledException
Update the menu definition with the new data.
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
Delete a menu definition.
customizationContext
- customization information such as prefered locales and desktopInstanceIdmenuDefinitionId
- the id of the menu definition to delete.
ObjectNotFoundException
- if the menuDefinitionId is bogus
ObjectInUseException
- if page instances are currently using this menu
NotEntitledException
- the caller is not entitled to perform this operation.
RemoteException
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
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.
customizationContext
- customization information such as prefered locales and desktopInstanceIddeleteMenuDefinitionId
- the id of the menu definition to delete.replacementMenuDefinitionId
- the id of the replacement menu
ObjectNotFoundException
- if either of the menuDefinitionIds are bogus
NotEntitledException
- the caller is not entitled to perform this operation.
RemoteException
deleteMenuDefinition(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.MenuDefinitionId)
public MenuDefinitionId getMenuDefinitionId(CustomizationContext customizationContext, String markupName, String webAppName) throws RemoteException
Getter for returning a single MenuDefinitionId
object given a supplied menu
markup name.
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 |