com.sap.workspaces.module.extension

Class AbstractModuleViewOptions

java.lang.Object
  com.sap.workspaces.module.extension.AbstractModuleViewOptions

public abstract class AbstractModuleViewOptions
extends Object

In addition to its default view, a module can have other views; extend this abstract class to include additional views as options to the module tray

Since:

1.1

Field Summary

static String

MODULE_PCD_ID The name of the request parameter that contains the module's PCD ID

Constructor Summary

AbstractModuleViewOptions()

Method Summary

abstract ViewOption.ViewInfo	getInitialView(IModuleContext moduleContext) Returns the module view to be displayed as initial instead of the default view; to revert the initial view back to default, raise the 'iviewReset' EPCM event, for example: var topSAPWindow = EPCM.getSAPTop(); var data = {ivuId:moduleID}; topSAPWindow.EPCM.raiseEvent( 'urn:com.sap.portal.ajaxpagebuilder', 'iviewReset', data );
abstract ViewOption[]	getViewOptions(IModuleContext moduleContext) Returns an array of view options for the specified module, current user and locale.
abstract boolean	removeOptionSettings(IModuleContext moduleContext) Defines whether to remove the "Settings" option; if true, the option is removed, otherwise it remains; default is false The "Delete" option cannot be removed

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_PCD_ID

public static final String MODULE_PCD_ID

The name of the request parameter that contains the module's PCD ID

See Also:

Constant Field Values

Constructor Detail

AbstractModuleViewOptions

public AbstractModuleViewOptions()

Method Detail

getViewOptions

public abstract ViewOption[] getViewOptions(IModuleContext moduleContext)

Returns an array of view options for the specified module, current user and locale.

Parameters:

moduleContext - the module context

Returns:

An array of view options of the module

removeOptionSettings

public abstract boolean removeOptionSettings(IModuleContext moduleContext)

Defines whether to remove the "Settings" option; if true, the option is removed, otherwise it remains; default is false The "Delete" option cannot be removed

Parameters:

moduleContext - the module context

getInitialView

public abstract ViewOption.ViewInfo getInitialView(IModuleContext moduleContext)

Returns the module view to be displayed as initial instead of the default view; to revert the initial view back to default, raise the 'iviewReset' EPCM event, for example:

        var topSAPWindow = EPCM.getSAPTop();
        var data = {ivuId:moduleID};
        topSAPWindow.EPCM.raiseEvent( 'urn:com.sap.portal.ajaxpagebuilder', 'iviewReset', data ); 
 

Parameters:

moduleContext - the module context

Returns:

The module view to be displayed as initial; if null, the module will not display an initial view different from the default view