com.sap.workspaces.module

Interface IModuleContextFactory

All Superinterfaces:

IWorkspacesService

public interface IModuleContextFactory
extends IWorkspacesService

Provides methods to access the runtime context of a module instance. The following example illustrates retrieval of the module context using the API calls:


IWorkspacesRuntime runtime = RuntimeFactory.getWorkspacesRuntime();
IModuleContextFactory contextFactory = runtime.getService(IModuleContextFactory.class);
IModuleContext context = contextFactory.getModuleContext(request);


Method Summary

IModuleContext	getModuleContext(IIdentifier workspaceID, String moduleInstanceID, com.sap.security.api.IUser user) Deprecated. Returns the context of a module specified by the workspace, module and user, in the original locale
IModuleContext	getModuleContext(IIdentifier workspaceID, String moduleInstanceID, com.sap.security.api.IUser user, Locale locale) Returns the context of a module specified by the workspace, module, user and locale
IModuleContext	getModuleContext(com.sapportals.portal.prt.component.IPortalComponentRequest request) Returns the context of a module specified by the current request
IModuleContext	getModuleContext(String modulePCDPath, com.sap.security.api.IUser user) Deprecated. Returns the context of a module specified by the module’s PCD path and user, in the original locale
IModuleContext	getModuleContext(String modulePCDPath, com.sap.security.api.IUser user, Locale locate) Returns the context of a module specified by the module’s PCD path, user and locale

Method Detail

getModuleContext

IModuleContext getModuleContext(com.sapportals.portal.prt.component.IPortalComponentRequest request)
                                throws WorkspacesRuntimeException

Returns the context of a module specified by the current request

Parameters:

request - the current request

Returns:

The module context

Throws:

WorkspacesRuntimeException - if an error occurs or the current running component is not a module instance

getModuleContext

IModuleContext getModuleContext(IIdentifier workspaceID,
                                String moduleInstanceID,
                                com.sap.security.api.IUser user,
                                Locale locale)
                                throws WorkspacesRuntimeException

Returns the context of a module specified by the workspace, module, user and locale

Parameters:

workspaceID - the workspace identifier

moduleInstanceID - the module instance ID

user - the user

locale - the locale

Returns:

The module context

Throws:

WorkspacesRuntimeException

getModuleContext

IModuleContext getModuleContext(IIdentifier workspaceID,
                                String moduleInstanceID,
                                com.sap.security.api.IUser user)
                                throws WorkspacesRuntimeException

Deprecated. Returns the context of a module specified by the workspace, module and user, in the original locale

Parameters:

workspaceID - the workspace identifier

moduleInstanceID - the module instance ID

user - the user

Returns:

The module context

Throws:

WorkspacesRuntimeException

getModuleContext

IModuleContext getModuleContext(String modulePCDPath,
                                com.sap.security.api.IUser user,
                                Locale locate)
                                throws WorkspacesRuntimeException

Returns the context of a module specified by the module’s PCD path, user and locale

Parameters:

modulePCDPath - the PCD path of the module instance

user - the user

locale - the locale

Returns:

The module context

Throws:

WorkspacesRuntimeException

getModuleContext

IModuleContext getModuleContext(String modulePCDPath,
                                com.sap.security.api.IUser user)
                                throws WorkspacesRuntimeException

Deprecated. Returns the context of a module specified by the module’s PCD path and user, in the original locale

Parameters:

modulePCDPath - the PCD path of the module instance

user - the user

Returns:

The module context

Throws:

WorkspacesRuntimeException