|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMenuDefinitionManager
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 preferred 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.
"Definitions" can be thought of as objects in the library. Objects in the library are not associated to any one Desktop. In other words definitions can be placed on zero or more desktops and changes made in the library (to the definitions) are cascaded down to object on the desktops. If you are only interested in affecting a single desktop then use thePortalCustomizationManager
and
make changes to the "Instances".
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. |
MenuDefinition[] |
getMenuDefinitions(CustomizationContext customizationContext,
String webapp,
MenuDefinitionId firstMenuDefinitionId,
int limit)
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. |
SortableFilterablePagedResult<MenuDefinition> |
getMenuDefinitions(CustomizationContext customizationContext,
WebAppSearchCriteria searchCriteria,
int pageSize)
Get all the menu definitions for the webapp as a paged object. |
MenuView |
getMenuView(CustomizationContext customizationContext,
MenuDefinitionId menuDefinitionId)
Getter for returning an immutable deep MenuView. |
SortableFilterablePagedResult<LocalizationResourceView> |
getVisibleMenuLocalizationResources(CustomizationContext customizationContext,
WebAppSearchCriteria criteria,
int pageSize)
Retrieve the LocalizationResourceViews for all visible menus for a given locale and webapp. |
void |
updateMenuDefinition(CustomizationContext customizationContext,
MenuDefinition menuDefinition)
Update the menu definition with the new data. |
Method Detail |
---|
MenuView getMenuView(CustomizationContext customizationContext, MenuDefinitionId menuDefinitionId) throws RemoteException
Getter for returning an immutable deep 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 preferred locales and desktopInstanceIdmenuDefinitionId
- the unique menuDefinitionId.
RemoteException
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 preferred locales and desktopInstanceIdwebapp
- the web application these menu definitions are scoped to.
MenuDefinition
objects if they exist, otherwise, an empty array.
RemoteException
MenuDefinition
MenuDefinition[] getMenuDefinitions(CustomizationContext customizationContext, String webapp, MenuDefinitionId firstMenuDefinitionId, int limit) throws RemoteException
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.
The implmentation has to ensure that repeated calls to this
method return MenuDefinition
s in a consistent
order.
customizationContext
- customization information such as preferred locales.webapp
- the web application these menu definitions are scoped to.firstMenuDefinitionId
- optional parameter to indicate where the list should start.limit
- the maximum result set size. Note the limit may be negative indicating a reverse sort order.
To retrieve all the records specify a limit of zero.
Note: some elements may be pruned because of entitlements.
MenuDefinition
s no greater than limit
in size.
RemoteException
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 preferred locales and desktopInstanceIdmenuDefinitionId
- the unique menu definition identifier.
MenuDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
- Throws
RemoteException
- See Also
MenuDefinition
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 preferred 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 if the object does not exist.
RemoteException
MenuDefinition
MenuDefinition createMenuDefinition(CustomizationContext customizationContext, MenuDefinition menuDefinition) throws RemoteException, MissingDataException, NotEntitledException
customizationContext
- customization information such as preferred locales and desktopInstanceIdmenuDefinition
- the menu data and associated placeholders
MissingDataException
- the menuDefinition supplied as an argument is missing some vital data.
NotEntitledException
- the caller is not entitled to create a new menu.
RemoteException
void updateMenuDefinition(CustomizationContext customizationContext, MenuDefinition menuDefinition) throws RemoteException, ObjectNotFoundException, NotEntitledException
Update the menu definition with the new data.
customizationContext
- customization information such as preferred locales and desktopInstanceIdmenuDefinition
- the menu definition containing the new data
ObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.
RemoteException
NotEntitledException
void deleteMenuDefinition(CustomizationContext customizationContext, MenuDefinitionId menuDefinitionId) throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
Delete a menu definition.
customizationContext
- customization information such as preferred 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)
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 without having to delete those book instances.
customizationContext
- customization information such as preferred 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)
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 preferred locales and desktopInstanceIdmarkupName
- the markup name attribute supplied on the tag,webAppName
- as defined in the config.xml
RemoteException
SortableFilterablePagedResult<LocalizationResourceView> getVisibleMenuLocalizationResources(CustomizationContext customizationContext, WebAppSearchCriteria criteria, int pageSize) throws RemoteException
customizationContext
- - a customization context with a request and locale defined. Only the first locale is used.criteria
- - specifies the name of the web application where the requested resources livepageSize
- - number of results to retrieve per page
SortableFilterablePagedResult
of visible Menu
LocalizationResources
RemoteException
SortableFilterablePagedResult<MenuDefinition> getMenuDefinitions(CustomizationContext customizationContext, WebAppSearchCriteria searchCriteria, int pageSize) throws RemoteException
customizationContext
- customization information such as preferred locales and http request.searchCriteria
- used to specify the webapppageSize
- the number of item per page in the result.
RemoteException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |