com.sap.workspaces.workspace

Class AbstractControlModuleMenu

java.lang.Object
  com.sap.workspaces.workspace.AbstractControlModuleMenu

All Implemented Interfaces:

IWorkspacesService

public abstract class AbstractControlModuleMenu
extends Object
implements IWorkspacesService

Extend this class to centrally control menus of all modules in workspaces. You can add, remove or reorder the custom view options of each module; the standard ‘Settings’ and ‘Delete’ options are not affected. Your implementation will be called each time a module is loaded on a page.

Since:

1.1 SP02

Constructor Summary

AbstractControlModuleMenu()

Method Summary

abstract ViewOption[]

getViewOptions(IModuleID moduleID, ViewOption[] viewOptions, com.sap.security.api.IUser user, Locale locale) Controls the list of custom view options in a module’s menu.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractControlModuleMenu

public AbstractControlModuleMenu()

Method Detail

getViewOptions

public abstract ViewOption[] getViewOptions(IModuleID moduleID,
                                            ViewOption[] viewOptions,
                                            com.sap.security.api.IUser user,
                                            Locale locale)

Controls the list of custom view options in a module’s menu. The method receives an array of existing view options of a module, implemented as a ViewOption module extension. In the method’s implementation, you can define and add other view options, or remove any existing custom option , as well as change their order. You can apply additional business logic based on the received parameters.

Parameters:

moduleID - the ID of the module to which the view options are added

viewOptions - an array of existing custom view options; empty if no custom options exist

user - the current user

locale - the current locale

Returns:

A modified array of the view options for the specified module. Return an empty array to indicates that no custom options should be available.