|
Enterprise Workspaces 1.1 | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use WorkspacesRuntimeException | |
|---|---|
| com.sap.workspaces | Serves as an entry point to the Enterprise Workspaces API |
| com.sap.workspaces.authoring | Provides information related to workspace authoring |
| com.sap.workspaces.content | Provides tools that enable you to integrate and manage external content in workspaces |
| com.sap.workspaces.directory | Provides access to the functionality of workspace directory |
| 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.workspace | Provides tools to access workspace data, such as properties, roles, pages, categories and members |
| Uses of WorkspacesRuntimeException in com.sap.workspaces |
|---|
| Methods in com.sap.workspaces that throw WorkspacesRuntimeException | |
|---|---|
IWorkspacesService |
IWorkspacesRuntime.getService(Class interfaceClass)
Returns an implementation of the specified service interface |
IWorkspacesService[] |
IWorkspacesRuntime.getServices(Class interfaceClass)
Returns an array of existing implementations of the specified service interface, if the service interface has multiple implementations; similar to IWorkspacesRuntime.getService(Class) |
| Uses of WorkspacesRuntimeException in com.sap.workspaces.authoring |
|---|
| Methods in com.sap.workspaces.authoring that throw WorkspacesRuntimeException | |
|---|---|
void |
IWriteProtectMode.assertWriteProtectOff()
Throws a runtime exception if the PCD is in write-protect mode; call this method if you want to handle this exception |
| Uses of WorkspacesRuntimeException in com.sap.workspaces.content |
|---|
| Methods in com.sap.workspaces.content that throw WorkspacesRuntimeException | |
|---|---|
abstract String |
AbstractModule.getContent(com.sapportals.portal.prt.component.IPortalComponentRequest request)
Depending on the module's isolation mode, returns: if isolated, the URL of the module; if embedded, the HTML markup of the module content |
abstract String |
AbstractModule.getContentForIndexing()
Returns the textual content of the module for the purposes of indexing; can be an empty string if no content exist or is not available. |
| Uses of WorkspacesRuntimeException in com.sap.workspaces.directory |
|---|
| Methods in com.sap.workspaces.directory that throw WorkspacesRuntimeException | |
|---|---|
int |
IWorkspaceDirectory.getWorkspacesCount(com.sap.security.api.IUser user,
WorkspaceFilter filter)
Counts workspaces according to the conditions specified by the workspace filter |
ISearchResults |
IWorkspaceDirectory.getWorkspacesInfo(com.sap.security.api.IUser user,
WorkspaceRole workspaceRole,
SortBy sortBy,
int startFrom,
int maxResults)
Returns workspace metadata for the specified user and workspace role in a sorted array |
Map |
IWorkspaceDirectory.getWorkspacesInfo(List IDs)
Returns workspace metadata for the shared workspaces specified by their IDs. |
boolean |
IWorkspaceDirectory.isUserInRole(com.sap.security.api.IUser user,
Role role)
Checks whether the specified user is in the specified role, such as the workspace content administrator role |
ISearchResults |
IWorkspaceDirectory.search(SearchControl searchControl)
Searches for public and restricted, but not private, workspaces according to the parameters specified by the SearchControl |
| Uses of WorkspacesRuntimeException in com.sap.workspaces.indexing |
|---|
| Methods in com.sap.workspaces.indexing that throw WorkspacesRuntimeException | |
|---|---|
abstract AbstractIndexItem[] |
AbstractIndexItem.getChildren()
Currently not supported |
abstract String |
AbstractIndexItem.getDescription()
Returns the item description |
abstract String |
AbstractIndexItem.getName()
Returns the item name |
abstract String[] |
AbstractIndexItem.getTexts()
Returns the item textual content in an array; |
| Uses of WorkspacesRuntimeException in com.sap.workspaces.module |
|---|
| Methods in com.sap.workspaces.module that throw WorkspacesRuntimeException | |
|---|---|
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 |
| Uses of WorkspacesRuntimeException in com.sap.workspaces.module.extension |
|---|
| Subclasses of WorkspacesRuntimeException in com.sap.workspaces.module.extension | |
|---|---|
class |
LinkException
An exception thrown when a link cannot be added to a module |
class |
ModuleLifecycleException
An exception that is thrown when a module lifecycle event fails. |
| Uses of WorkspacesRuntimeException in com.sap.workspaces.module.settings |
|---|
| Methods in com.sap.workspaces.module.settings that throw WorkspacesRuntimeException | |
|---|---|
IModuleSettings |
IModuleSettingsFactory.getModuleSettings(IModuleContext moduleContext)
Returns the settings for the specified module context |
void |
IModuleSettingsFactory.saveModuleSettings(IModuleSettings moduleSettings)
Saves the specified module settings without callback |
void |
IModuleSettingsFactory.saveModuleSettingsWithCallback(IModuleSettings moduleSettings)
Saves the specified module settings and invokes the onChangeSettings callback of the AbstractModuleLifecycle class |
| Uses of WorkspacesRuntimeException in com.sap.workspaces.workspace |
|---|
| Subclasses of WorkspacesRuntimeException in com.sap.workspaces.workspace | |
|---|---|
class |
MemberListException
Enumeration of the member list runtime exceptions |
| Methods in com.sap.workspaces.workspace that throw WorkspacesRuntimeException | |
|---|---|
void |
IPage.addModule(com.sap.security.api.IUser user,
String contentProviderID,
String contentID)
Adds a workspace module or an external content item as a module to the page |
void |
IApproval.approve(boolean approve,
com.sap.security.api.IUser approver,
IWorkspace workspace,
String reason)
Call to approve or reject a newly created workspace |
IPage |
IWorkspace.createPage(com.sap.security.api.IUser user,
String pageName)
Creates a workspace page |
void |
IWorkspaceFactory.createPersonal(com.sap.security.api.IUser user,
Locale locale)
Creates a personal workspace for the specified user |
IIdentifier |
IWorkspaceFactory.createShared(com.sap.security.api.IUser user,
WorkspaceProperties workspaceProperties)
Creates a shared workspace and assigns ownership to the specified user |
boolean |
IWorkspace.deletePage(com.sap.security.api.IUser user,
String pageID)
Deletes a workspace page |
void |
IWorkspaceFactory.deleteWorkspace(com.sap.security.api.IUser user,
IIdentifier identifier)
Deletes the specified workspace |
ICategory[] |
ICategories.getCategories(com.sap.security.api.IUser user)
Returns an array of all workspace categories defined in the system |
String[] |
ICategories.getCategoriesInUse(Type[] workspaceTypes,
PermissionPolicy[] permissionPolicies,
Status[] statuses)
Returns an array of IDs of the categories used in the workspaces that match the specified conditions |
ICategory |
ICategories.getCategory(com.sap.security.api.IUser user,
String categoryID)
Returns the specified workspace category |
IModuleID[] |
IPage.getModuleIdentifiers()
Returns an array of module IDs of all modules in the page |
String[] |
IPage.getModuleIDs()
Deprecated. use IPage.getModuleIdentifiers() instead.
Returns an array of IDs of all modules in the page |
IPage |
IWorkspace.getPage(String ID)
Returns a workspace page with the specified ID |
IPage[] |
IWorkspace.getPages()
Returns an array of the workspace pages |
IWorkspace |
IWorkspaceFactory.getWorkspace(com.sap.security.api.IUser user,
IIdentifier identifier)
Returns the specified workspace |
boolean |
IWorkspace.movePage(com.sap.security.api.IUser user,
IPage page,
int newPosition)
|
boolean |
IPage.rename(com.sap.security.api.IUser user,
String newName)
Renames the page |
void |
IWorkspace.setStatus(com.sap.security.api.IUser user,
Status newStatus,
String reason)
Defines the workspace status |
void |
IWorkspace.update(WorkspaceProperties workspaceProperties,
com.sap.security.api.IUser user)
Updates the workspace properties |
|
Enterprise Workspaces 1.1 | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||