|
Enterprise Workspaces 1.1 | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use IModuleContext | |
|---|---|
| com.sap.workspaces.indexing | Enables you to prepare workspace content for indexing by search engines |
| com.sap.workspaces.module | Provides access to the runtime data of a module. |
| com.sap.workspaces.module.extension | Enables you to implement various extension services for custom modules, such as responding to the module lifecycle events, controlling their runtime behavior, adding links, calculating space usage, and more. |
| com.sap.workspaces.module.settings | Provides access to the runtime settings of the configuration properties of a module instance. |
| com.sap.workspaces.module.storage | Enables storage and retrieval of the runtime content of a module instance. |
| Uses of IModuleContext in com.sap.workspaces.indexing |
|---|
| Methods in com.sap.workspaces.indexing with parameters of type IModuleContext | |
|---|---|
static ItemInfo |
ItemInfoHelper.createModuleItemInfo(IModuleContext moduleContext)
Creates an ItemInfo object of the module instance. |
| Uses of IModuleContext in com.sap.workspaces.module |
|---|
| Methods in com.sap.workspaces.module that return IModuleContext | |
|---|---|
static IModuleContext |
ModuleHelper.getModuleContext(IIdentifier workspaceID,
String instanceID,
com.sap.security.api.IUser user)
Deprecated. Returns the module context specified by the workspace ID, module instance ID and user, in the original locale |
IModuleContext |
IModuleContextFactory.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 |
static IModuleContext |
ModuleHelper.getModuleContext(IIdentifier workspaceID,
String instanceID,
com.sap.security.api.IUser user,
Locale locale)
Returns the module context specified by the workspace ID, module instance ID, user and locale |
IModuleContext |
IModuleContextFactory.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 |
static IModuleContext |
ModuleHelper.getModuleContext(com.sapportals.portal.prt.component.IPortalComponentRequest request)
Returns the module context specified by the current request |
IModuleContext |
IModuleContextFactory.getModuleContext(com.sapportals.portal.prt.component.IPortalComponentRequest request)
Returns the context of a module specified by the current request |
static IModuleContext |
ModuleHelper.getModuleContext(String modulePCDPath,
com.sap.security.api.IUser user)
Deprecated. Returns Returns the context of a module specified by the module’s PCD path and user |
IModuleContext |
IModuleContextFactory.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 |
static IModuleContext |
ModuleHelper.getModuleContext(String modulePCDPath,
com.sap.security.api.IUser user,
Locale locale)
Returns the context of a module specified by the module’s PCD path, user and locale |
IModuleContext |
IModuleContextFactory.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 |
| Methods in com.sap.workspaces.module with parameters of type IModuleContext | |
|---|---|
LockInfo |
ILocking.forceLock(IModuleContext context)
Forces lock on the specified module for the current user, regardless of the module’s locking status |
LockInfo |
ILocking.getLockInfo(IModuleContext context)
Returns the locking status of the specified module context |
LockInfo |
ILocking.lock(IModuleContext context)
Locks the specified module for the current user. |
void |
IModuleEvents.moduleUpdated(IModuleContext context)
Raises an event when the specified module is updated. |
boolean |
ILocking.releaseLock(IModuleContext context)
Releases the lock on the specified module, if it was locked by the current user |
| Uses of IModuleContext in com.sap.workspaces.module.extension |
|---|
| Methods in com.sap.workspaces.module.extension with parameters of type IModuleContext | |
|---|---|
abstract void |
AbstractLink.addLink(IModuleContext moduleContext,
LinkInfo linkInfo)
A callback invoked when the specified link is added to the module |
IModuleTransport.IExportEntry[] |
IModuleTransport.getExportEntries(IModuleContext context)
Deprecated. Implementing modules should return an array of callback entries to export. |
abstract AbstractExportEntry[] |
AbstractModuleTransport.getExportEntries(IModuleContext context)
Called before the workspace is exported. returns an array of entries to export |
abstract AbstractIndexItem |
AbstractModuleIndexData.getIndexItem(IModuleContext moduleContext,
ItemInfo itemInfo)
Provides the module data for indexing; invoked, for example, when the module content has changed. |
abstract ViewOption.ViewInfo |
AbstractModuleViewOptions.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, call the resetInitialView method |
abstract ViewOption[] |
AbstractModuleViewOptions.getViewOptions(IModuleContext moduleContext)
Returns an array of view options for the specified module, current user and locale. |
abstract void |
AbstractModuleTransport.importEntries(IModuleContext context,
AbstractImportEntry[] importEntries)
Called after a workspace is imported. |
void |
IModuleTransport.importEntries(IModuleContext context,
IModuleTransport.IImportEntry[] importEntries)
Deprecated. A callback invoked after a workspace in imported. |
void |
IPrincipalLifecycle.onAddPrincipal(PrincipalInfo principalInfo,
IModuleContext moduleContext)
Deprecated. Called when a principal is added to the workspace |
abstract void |
AbstractPrincipalLifecycle.onAddPrincipal(PrincipalInfo principalInfo,
IModuleContext moduleContext)
Called when a principal is added to the workspace |
void |
IModuleLifecycle.onChangeSettings(IModuleContext moduleContext,
ChangedSetting[] changedSettings)
Deprecated. A callback invoked when one or more settings of a module instance are modified. |
abstract void |
AbstractModuleLifecycle.onChangeSettings(IModuleContext moduleContext,
ChangedSetting[] changedSettings)
This callback is invoked when one or more settings of a module instance are modified. |
void |
IModuleLifecycle.onCreate(IModuleContext context)
Deprecated. A callback invoked when a module instance is created and added to a workspace. |
abstract void |
AbstractModuleLifecycle.onCreate(IModuleContext context)
This callback is invoked when a module instance is created and added to a workspace. |
void |
IModuleLifecycle.onDelete(IModuleContext context)
Deprecated. A callback invoked when a module instance is removed from workspace. |
abstract void |
AbstractModuleLifecycle.onDelete(IModuleContext context)
This callback is invoked before a module instance is removed from workspace. |
void |
IPrincipalLifecycle.onRemovePrincipal(PrincipalInfo principalInfo,
IModuleContext moduleContext)
Deprecated. Called when a principal is removed from the workspace |
abstract void |
AbstractPrincipalLifecycle.onRemovePrincipal(PrincipalInfo principalInfo,
IModuleContext moduleContext)
Called when a principal is removed from the workspace |
abstract boolean |
AbstractModuleViewOptions.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 |
| Uses of IModuleContext in com.sap.workspaces.module.settings |
|---|
| Methods in com.sap.workspaces.module.settings that return IModuleContext | |
|---|---|
IModuleContext |
IModuleSettings.getModuleContext()
Returns the module context |
| Methods in com.sap.workspaces.module.settings with parameters of type IModuleContext | |
|---|---|
IModuleSettings |
IModuleSettingsFactory.getModuleSettings(IModuleContext moduleContext)
Returns the settings for the specified module context |
| Uses of IModuleContext in com.sap.workspaces.module.storage |
|---|
| Methods in com.sap.workspaces.module.storage with parameters of type IModuleContext | |
|---|---|
void |
IModuleStorageFactory.deleteStorage(IModuleContext context)
Destroys the module storage |
IModuleStorage |
IModuleStorageFactory.getStorage(IModuleContext context)
Returns the module storage; if the storage does not exist, creates it |
boolean |
IModuleStorageFactory.hasStorage(IModuleContext context)
Determines whether the module instance has storage |
|
Enterprise Workspaces 1.1 | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||