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 effecting a single desktop then use thePortalCustomizationManager
and
make changes to the "Instances".
BookDefinitionManager
Method Summary |
public |
|
public void |
|
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public void |
|
Method Detail |
publicCreates a new MenuView Definition with its placeholders.MenuDefinition
createMenuDefinition(CustomizationContext
customizationContext,MenuDefinition
menuDefinition)
throwsRemoteException
,MissingDataException
,NotEntitledException
RemoteException
MissingDataException
NotEntitledException
public void deleteMenuDefinition(CustomizationContext
customizationContext,MenuDefinitionId
menuDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,ObjectInUseException
,NotEntitledException
Delete a menu definition.
RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException
Related Topics
public void deleteMenuDefinitionWithReplacement(CustomizationContext
customizationContext,MenuDefinitionId
deleteMenuDefinitionId,MenuDefinitionId
replacementMenuDefinitionId)
throwsRemoteException
,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.
RemoteException
ObjectNotFoundException
NotEntitledException
Related Topics
IMenuDefinitionManager.deleteMenuDefinition(CustomizationContext, MenuDefinitionId)
publicMenuDefinition
getMenuDefinition(CustomizationContext
customizationContext,MenuDefinitionId
menuDefinitionId)
throwsRemoteException
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
Related Topics
publicMenuDefinition
getMenuDefinitionFromFile(CustomizationContext
customizationContext,String
menuFileName,String
webAppName)
throwsRemoteException
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
Related Topics
publicMenuDefinitionId
getMenuDefinitionId(CustomizationContext
customizationContext,String
markupName,String
webAppName)
throwsRemoteException
Getter for returning a single MenuDefinitionId
object given a supplied menu
markup name.
RemoteException
publicMenuDefinition
[] getMenuDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
Getter for returning a list of all MenuDefinitions
scoped to the supplied webapp.
MenuDefinition
objects if they exist, otherwise, an empty array. RemoteException
Related Topics
publicMenuDefinition
[] getMenuDefinitions(CustomizationContext
customizationContext,String
webapp,MenuDefinitionId
firstMenuDefinitionId, int limit)
throwsRemoteException
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
publicMenuView
getMenuView(CustomizationContext
customizationContext,MenuDefinitionId
menuDefinitionId)
throwsRemoteException
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
public void updateMenuDefinition(CustomizationContext
customizationContext,MenuDefinition
menuDefinition)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Update the menu definition with the new data.
RemoteException
ObjectNotFoundException
NotEntitledException