com.bea.portal.tools.portal.controls
Interface MenuDefinitionControl

@ControlInterface
public interface MenuDefinitionControl

A custom control interface used to interact with MenuDefinitionControls.

Method Summary

void	deleteMenuDefinitions(MenuDefinitionId id, ResourceContext context) Deletes the specified menu definition.
MenuDefinition	getMenuDefinition(MenuDefinitionId id, ResourceContext context) Returns a MenuDefinition from a menu definition id.
SortableFilterablePagedResult<MenuDefinition>	getMenuDefinitions(int pageSize, WebAppSearchCriteria criteria, ResourceContext context) Gets a page iterator of menu definitions.

Method Detail

getMenuDefinitions

SortableFilterablePagedResult<MenuDefinition> getMenuDefinitions(int pageSize,
                                                                 WebAppSearchCriteria criteria,
                                                                 ResourceContext context)
                                                                 throws ToolsException

Gets a page iterator of menu definitions.

Parameters

pageSize - The size of a page of data with the SortableFilterablePagedResult.

criteria - criteria specifying the webApp to search

context - the resource context

Returns

A SortableFilterablePagedResult of MenuDefinitions.

Throws

ToolsException

getMenuDefinition

MenuDefinition getMenuDefinition(MenuDefinitionId id,
                                 ResourceContext context)
                                 throws ToolsException

Returns a MenuDefinition from a menu definition id.

Parameters

id - the ID of the MenuDefinition to retrieve

context - the resource context

Returns

The MenuDefinition object.

Throws

ToolsException

deleteMenuDefinitions

void deleteMenuDefinitions(MenuDefinitionId id,
                           ResourceContext context)
                           throws ObjectInUseException,
                                  ToolsException,
                                  NotEntitledException,
                                  ObjectNotFoundException

Deletes the specified menu definition.

Parameters

id - The id of the menu definition to delete.

context - the resource context

Throws

ObjectInUseException

ToolsException

NotEntitledException

ObjectNotFoundException