A C D E G H I L M N O P Q R S T U V W

A

addGroup(IUser, IGroup) - Method in interface com.sap.workspaces.workspace.IRole

Adds the specified group to the role

addUser(IUser, IUser) - Method in interface com.sap.workspaces.workspace.IRole

Adds the specified user to the role

addUser(IUser, IUser, String) - Method in interface com.sap.workspaces.workspace.IRole

Adds the specified user to the role

ALREADY_MEMBER - Static variable in exception com.sap.workspaces.workspace.MemberListException

The user is already a member of the workspace

AND - Static variable in class com.sap.workspaces.directory.SearchMethod

combine by AND

ATTRIBUTE_VALUE_VISIBILITY_MODIFY - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

"modify" value for the "workspaceManagerPermissions"

ATTRIBUTE_VALUE_VISIBILITY_NONE - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

"none" value for the attribute "workspaceManagerPermissions"

ATTRIBUTE_VALUE_VISIBILITY_READ - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

"read" value for the attribute "workspaceManagerPermissions"

C

ChangedSetting - Class in com.sap.workspaces.module.extension

Provides information about the changed setting of a module

ChangedSetting(String, String, String) - Constructor for class com.sap.workspaces.module.extension.ChangedSetting

CLOSED - Static variable in class com.sap.workspaces.workspace.Status

The workspace is closed

com.sap.workspaces - package com.sap.workspaces

Serves as an entry point to the Enterprise Workspaces API

com.sap.workspaces.directory - package com.sap.workspaces.directory

Provides access to the functionality of workspace directory

com.sap.workspaces.module - package com.sap.workspaces.module

Represents the runtime context of module instance and provides helper for getting the context.

com.sap.workspaces.module.extension - package com.sap.workspaces.module.extension

Enables you to implement callback methods for responding to the module lifecycle events.

com.sap.workspaces.module.settings - package com.sap.workspaces.module.settings

Provides access to the runtime settings of module instance's properties.

com.sap.workspaces.module.settings.property - package com.sap.workspaces.module.settings.property

Provides access to the module property's metadata.

com.sap.workspaces.module.storage - package com.sap.workspaces.module.storage

Enables storage of the module instance's runtime content.

com.sap.workspaces.workspace - package com.sap.workspaces.workspace

Provides access to the workspace instances, pages, modules and members

CONFIG_KEY_MEMBER_CAN_LEAVE_WORKSPACE - Static variable in interface com.sap.workspaces.directory.IWorkspaceDirectory

A configuration key indicating whether a regular workspace member can leave a restricted workspace independently or should request this from a workspace manager or owner.

Constants - Interface in com.sap.workspaces.module.extension

CREATE_PERSONAL_WORKSPACE - Static variable in class com.sap.workspaces.TargetKey

The personal WS creation view

CREATE_SHARED_WORKSPACE - Static variable in class com.sap.workspaces.TargetKey

The shared WS creation view

CREATED_AT_ASCENDING - Static variable in class com.sap.workspaces.directory.SortBy

Sort by workspace creation date in the ascending order

CREATED_AT_DESCENDING - Static variable in class com.sap.workspaces.directory.SortBy

Sort by workspace creation date in the descending order

createdAt - Variable in class com.sap.workspaces.directory.WorkspaceInfo

createPersonal(IUser, Locale) - Method in interface com.sap.workspaces.workspace.IWorkspaceFactory

Creates a personal workspace for the specified user

createShared(IUser, WorkspaceProperties) - Method in interface com.sap.workspaces.workspace.IWorkspaceFactory

Creates a shared workspace and assigns ownership to the specified user

D

DEFAULT_MAX_RESULTS - Static variable in class com.sap.workspaces.directory.SearchControl

Default value of max search results

deleteProperty(String) - Method in interface com.sap.workspaces.module.storage.IModuleStorage

Deletes the property specified by the key parameter

deleteStorage(IModuleContext) - Method in interface com.sap.workspaces.module.storage.IModuleStorageFactory

Destroys the module storage

deleteWorkspace(IUser, IIdentifier) - Method in interface com.sap.workspaces.workspace.IWorkspaceFactory

Deletes the specified workspace

description - Variable in class com.sap.workspaces.directory.WorkspaceInfo

DRAFT - Static variable in class com.sap.workspaces.workspace.Status

he workspace is created but not published

E

equals(Object) - Method in class com.sap.workspaces.directory.Role

equals(Object) - Method in class com.sap.workspaces.directory.SearchMethod

equals(Object) - Method in class com.sap.workspaces.directory.SortBy

equals(Object) - Method in class com.sap.workspaces.module.extension.ExtensionType

equals(Object) - Method in class com.sap.workspaces.TargetKey

equals(Object) - Method in class com.sap.workspaces.workspace.PermissionPolicy

equals(Object) - Method in class com.sap.workspaces.workspace.Status

equals(Object) - Method in class com.sap.workspaces.workspace.Type

equals(Object) - Method in class com.sap.workspaces.workspace.WorkspaceRole

ExtensionType - Class in com.sap.workspaces.module.extension

ExtensionType(String) - Constructor for class com.sap.workspaces.module.extension.ExtensionType

G

getAttribute(String) - Method in interface com.sap.workspaces.module.settings.property.IBaseModuleProperty

Returns the specified attribute of the property.

getAttributes() - Method in interface com.sap.workspaces.module.settings.property.IBaseModuleProperty

Return all attributes of the property.

getBinaryProperty(String) - Method in interface com.sap.workspaces.module.storage.IModuleStorage

Returns the value of the specified binary property, or null if the property does not exist or does not have a value

getConfigValue(String) - Method in interface com.sap.workspaces.directory.IWorkspaceDirectory

Returns the value of the specified configuration key

getCreatedAt() - Method in class com.sap.workspaces.directory.WorkspaceInfo

Returns the workspace creation date

getCreatedAt() - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns the workspace creation date

getDescription() - Method in class com.sap.workspaces.directory.SearchFilter

Returns the workspace description to search for

getDescription() - Method in class com.sap.workspaces.directory.WorkspaceInfo

Returns the workspace description

getDescription() - Method in interface com.sap.workspaces.module.settings.property.IBaseModuleProperty

Returns the description of the property

getDescription() - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns the workspace description

getDescription() - Method in class com.sap.workspaces.workspace.TemplateInfo

Returns the template description

getDescription() - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Returns the workspace description

getErrorCode() - Method in exception com.sap.workspaces.WorkspacesRuntimeException

Return the error code that specifies the reason of failure

getExcludedWorkspaces() - Method in class com.sap.workspaces.directory.SearchControl

Returns the workspaces that should be excluded from the search results.

getExportEntries(IModuleContext) - Method in interface com.sap.workspaces.module.extension.IModuleTransport

Implementing modules should return an array of callback entries to export.

getExtensionService() - Method in interface com.sap.workspaces.module.IRuntimeExtension

Returns a reference to an extension service, or null if the service is not found or is not a PRT service

getExtensionType() - Method in interface com.sap.workspaces.module.IRuntimeExtension

Returns the type of extension service, such as LIFECYCLE or PRINCIPAL

getGroups() - Method in interface com.sap.workspaces.workspace.IRole

Returns all groups in this role

getId() - Method in interface com.sap.workspaces.module.extension.IModuleTransport.IExportEntry

Returns the ID of an entry

getId() - Method in interface com.sap.workspaces.module.extension.IModuleTransport.IImportEntry

Returns the ID of an entry

getID() - Method in class com.sap.workspaces.module.extension.PrincipalInfo

Returns the role ID

getID() - Method in interface com.sap.workspaces.module.settings.property.IBaseModuleProperty

Returns the ID of the property

getID() - Method in interface com.sap.workspaces.workspace.IIdentifier

Returns the workspace ID

getID() - Method in interface com.sap.workspaces.workspace.IPage

Returns the page ID

getIdentifier() - Method in class com.sap.workspaces.directory.WorkspaceInfo

Returns the workspace identifier

getIdentifier() - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns the workspace identifier

getIdentifier(String) - Method in interface com.sap.workspaces.workspace.IWorkspaceFactory

Returns the identifier of a workspace specified by its full PCD ID

getIdentifier() - Method in class com.sap.workspaces.workspace.TemplateInfo

Returns the template identifier

getInputStream() - Method in interface com.sap.workspaces.module.extension.IModuleTransport.IImportEntry

Returns input stream

getInstanceID() - Method in interface com.sap.workspaces.module.IModuleID

Returns the module instance ID

getKey() - Method in class com.sap.workspaces.module.extension.ChangedSetting

Returns the key of the setting that has been changed

getLocale() - Method in class com.sap.workspaces.directory.SearchFilter

Returns the search language according to the user's locale

getLocale() - Method in interface com.sap.workspaces.module.IModuleContext

Returns the locale associated with the current request or user

getLocale() - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Returns the master locale of the workspace

getMaxResults() - Method in class com.sap.workspaces.directory.SearchControl

Retrieves the maximum number of workspaces to return as a result of the search.

getMemberList() - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns the member list of this workspace

getModuleContext(IPortalComponentRequest) - Method in interface com.sap.workspaces.module.IModuleContextFactory

Returns the context of a module specified by the current request

getModuleContext(IIdentifier, String, IUser) - Method in interface com.sap.workspaces.module.IModuleContextFactory

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

getModuleContext(String, IUser) - Method in interface com.sap.workspaces.module.IModuleContextFactory

Returns the context of a module specified by the moduleInstancePcdUrl and user

getModuleContext(IPortalComponentRequest) - Static method in class com.sap.workspaces.module.ModuleHelper

Returns the module context specified by the current request

getModuleContext(IIdentifier, String, IUser) - Static method in class com.sap.workspaces.module.ModuleHelper

Returns the module context specified by the workspace ID, a module instance ID and a user

getModuleContext(String, IUser) - Static method in class com.sap.workspaces.module.ModuleHelper

Returns the module context specified by the workspace ID, a module instance ID and a user

getModuleContext() - Method in interface com.sap.workspaces.module.settings.IModuleSettings

Returns the module context

getModuleID() - Method in interface com.sap.workspaces.module.IModuleContext

Returns the identifier of the module instance with which context is associated.

getModuleIDs() - Method in interface com.sap.workspaces.workspace.IPage

Returns an array of IDs of all modules in the page

getModuleProperties() - Method in interface com.sap.workspaces.module.settings.IModuleSettings

Returns all the configuration properties of the module

getModuleProperty(String) - Method in interface com.sap.workspaces.module.settings.IModuleSettings

Returns the specified configuration property of the module

getModuleRuntimeInfo() - Method in interface com.sap.workspaces.module.IModuleContext

Returns the runtime information of the module instance

getModuleSettings(IModuleContext) - Method in interface com.sap.workspaces.module.settings.IModuleSettingsFactory

Returns the module settings for the specified module context

getName() - Method in class com.sap.workspaces.directory.SearchFilter

Returns the workspace name to search for

getName() - Method in class com.sap.workspaces.directory.WorkspaceInfo

Returns the workspace name

getName() - Method in interface com.sap.workspaces.module.settings.IModuleSettings

Returns the module instance name

getName() - Method in interface com.sap.workspaces.module.settings.property.IBaseModuleProperty

Returns the property name

getName() - Method in interface com.sap.workspaces.workspace.IPage

Returns the page name

getName() - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns the workspace name

getName() - Method in class com.sap.workspaces.workspace.TemplateInfo

Returns the template name

getName() - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Returns the workspace name

getNavigationTarget() - Method in class com.sap.workspaces.directory.WorkspaceInfo

Returns the workspace navigation target URL, which can be passed to the EPCM.doNavigate(navigationTarget) method

getNavigationTarget(TargetKey) - Method in interface com.sap.workspaces.IWorkspacesRuntime

Returns a navigation target for the specified key.

getNavigationTarget() - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns the workspace navigation target URL, which can be passed to the EPCM.doNavigate(navigationTarget) method

getNewValue() - Method in class com.sap.workspaces.module.extension.ChangedSetting

Returns the new value of the setting

getOldValue() - Method in class com.sap.workspaces.module.extension.ChangedSetting

Returns the old value of the setting that has been changed

getOwner() - Method in class com.sap.workspaces.directory.SearchFilter

Returns the workspace owner to search for

getOwner() - Method in class com.sap.workspaces.directory.WorkspaceInfo

Returns the workspace owner or null if the user does not exist

getOwner() - Method in interface com.sap.workspaces.workspace.IMemberList

Returns the workspace owner or null if the user does not exist

getOwners() - Method in class com.sap.workspaces.directory.SearchFilter

Returns the list of login names of the workspace owners

getPage(String) - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns a workspace page with the specified ID

getPages() - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns an array of the workspace pages

getPermissionPolicies() - Method in class com.sap.workspaces.directory.SearchControl

Returns an array of workspace permission policies to include in the search, such as public or restricted.

getPermissionPolicy() - Method in class com.sap.workspaces.directory.WorkspaceInfo

Returns the workspace permission policy

getPermissionPolicy() - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns the workspace permission policy

getPermissionPolicy() - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Returns the workspace permission policy

getPersonalIdentifier(IUser) - Method in interface com.sap.workspaces.workspace.IWorkspaceFactory

Returns the identifier of the specified user's personal workspace

getProperty(String) - Method in interface com.sap.workspaces.module.IModuleContext

Returns the string value of the specified configuration property or null if this property is not defined

getProperty(String) - Method in interface com.sap.workspaces.module.storage.IModuleStorage

Returns the value of the specified string property, or null if the property does not exist or does not have a value

getPropertyAttribute(String, String) - Method in interface com.sap.workspaces.module.IModuleContext

Returns the value of the specified attribute or null if this attribute is not defined

getPropertyAttributeIDs(String) - Method in interface com.sap.workspaces.module.IModuleContext

Returns an array of all attributes of the property

getPropertyIDs() - Method in interface com.sap.workspaces.module.IModuleContext

Returns an array of all property IDs

getPropertyIDs() - Method in interface com.sap.workspaces.module.storage.IModuleStorage

Returns an array of property IDs

getPropertyType(String) - Method in interface com.sap.workspaces.module.storage.IModuleStorage

Return the type of the specified property

getRole(WorkspaceRole) - Method in interface com.sap.workspaces.workspace.IMemberList

Returns a workspace role of the specified type

getRuntimeExtension(String) - Method in interface com.sap.workspaces.module.IModuleRuntimeInfo

Returns module runtime extension of the specified type

getSearchFilter() - Method in class com.sap.workspaces.directory.SearchControl

Returns a SearchFilter object that defines additional search parameters.

getSearchMethod() - Method in class com.sap.workspaces.directory.SearchFilter

Returns the search method

getService(Class) - Method in interface com.sap.workspaces.IWorkspacesRuntime

Gets an Enterprise Spaces service for a given interface.

getSharedIdentifier(String) - Method in interface com.sap.workspaces.workspace.IWorkspaceFactory

Returns the identifier of a shared workspace specified by its ID

getSortBy() - Method in class com.sap.workspaces.directory.SearchControl

Returns the sort order of the search results.

getStartFrom() - Method in class com.sap.workspaces.directory.SearchControl

Returns the sequential number of the search result from which to start returning results.

getStatus() - Method in class com.sap.workspaces.directory.WorkspaceInfo

Returns the workspace status

getStatus() - Method in interface com.sap.workspaces.workspace.IWorkspace

Returns the workspace status, such as PUBLISHED, DRAFT or CLOSED

getStorage(IModuleContext) - Method in interface com.sap.workspaces.module.storage.IModuleStorageFactory

Returns the module storage; if the storage does not exist, creates it

getTemplateID() - Method in interface com.sap.workspaces.module.IModuleID

Returns the module template ID

getTemplateID(IUser) - Method in interface com.sap.workspaces.workspace.IPersonalTemplate

Returns the ID of a template used for the personal workspace of the specified user.

getTemplateID() - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Returns the workspace template ID

getTemplateInfo(Type, Locale) - Method in interface com.sap.workspaces.workspace.IWorkspaceFactory

Returns a list of workspace templates

getTotalNumberOfResults() - Method in interface com.sap.workspaces.directory.ISearchResults

Returns the total number of search results, which is either equal to or greater than the length of the WorkspaceInfo array returned by ISearchResults.getWorkspacesInfo().

getType() - Method in interface com.sap.workspaces.workspace.IIdentifier

Returns the workspace type

getURL() - Method in interface com.sap.workspaces.INavigationTarget

Gets the navigation target URL.

getUser() - Method in interface com.sap.workspaces.module.IModuleContext

Returns the current user.

getUsers() - Method in interface com.sap.workspaces.workspace.IRole

Returns all users in this role

getUsers(boolean) - Method in interface com.sap.workspaces.workspace.IRole

Returns all users in this role

getValidValues() - Method in interface com.sap.workspaces.module.settings.property.IModuleProperty

Returns all valid values of this property

getValue() - Method in interface com.sap.workspaces.module.settings.property.IBaseModuleProperty

Returns the value of the property.

getWorkspace(IUser, IIdentifier) - Method in interface com.sap.workspaces.workspace.IWorkspaceFactory

Returns workspace specified by its identifier

getWorkspaceID() - Method in interface com.sap.workspaces.module.IModuleID

Returns the workspace ID

getWorkspaceRole() - Method in class com.sap.workspaces.module.extension.PrincipalInfo

Returns the workspace role

getWorkspacesInfo() - Method in interface com.sap.workspaces.directory.ISearchResults

Returns an array of workspaces that match the search criteria defined by SearchControl.

getWorkspacesInfo(IUser, WorkspaceRole, SortBy, int, int) - Method in interface com.sap.workspaces.directory.IWorkspaceDirectory

Returns workspace metadata for the specified user and workspace role is a sorted array

getWorkspacesInfo(List) - Method in interface com.sap.workspaces.directory.IWorkspaceDirectory

Returns workspace metadata for the specified IDs of shared workspaces.

getWorkspacesRuntime() - Static method in class com.sap.workspaces.RuntimeFactory

Static method to retrieve an instance of IWorkspacesRuntime.

H

hashCode() - Method in class com.sap.workspaces.directory.Role

hashCode() - Method in class com.sap.workspaces.directory.SearchMethod

hashCode() - Method in class com.sap.workspaces.directory.SortBy

hashCode() - Method in class com.sap.workspaces.module.extension.ExtensionType

hashCode() - Method in class com.sap.workspaces.TargetKey

hashCode() - Method in class com.sap.workspaces.workspace.PermissionPolicy

hashCode() - Method in class com.sap.workspaces.workspace.Status

hashCode() - Method in class com.sap.workspaces.workspace.Type

hashCode() - Method in class com.sap.workspaces.workspace.WorkspaceRole

hasPersonalWorkspace(IUser) - Method in interface com.sap.workspaces.workspace.IWorkspaceFactory

Checks if the specified user already has a personal workspace

hasStorage(IModuleContext) - Method in interface com.sap.workspaces.module.storage.IModuleStorageFactory

Determines whether the module instance has storage

I

IBaseModuleProperty - Interface in com.sap.workspaces.module.settings.property

Represents a basic module property.

ID - Variable in class com.sap.workspaces.module.extension.PrincipalInfo

identifier - Variable in class com.sap.workspaces.directory.WorkspaceInfo

IIdentifier - Interface in com.sap.workspaces.workspace

Identifies a workspace by a combination of unique ID and workspace type

IMemberList - Interface in com.sap.workspaces.workspace

Provides an entry point for managing workspace members

IModuleContext - Interface in com.sap.workspaces.module

Represents the context for a specific module instance at runtime

IModuleContextFactory - Interface in com.sap.workspaces.module

Returns the runtime context of module instance.

IModuleID - Interface in com.sap.workspaces.module

Uniquely identifies a module instance by a combination of the module instance ID, module template ID and workspace ID.

IModuleLifecycle - Interface in com.sap.workspaces.module.extension

Provides callback methods that are invoked when the module is added to or removed from a workspace

IModuleProperty - Interface in com.sap.workspaces.module.settings.property

Represents a module property

IModulePropertyAttribute - Interface in com.sap.workspaces.module.settings.property

A marker interface for module property attribute

IModulePropertyValue - Interface in com.sap.workspaces.module.settings.property

A marker interface for module property value

IModuleRuntimeConstants - Interface in com.sap.workspaces.module

Declares constants for the configuration, module metadata, and framework internal properties

IModuleRuntimeInfo - Interface in com.sap.workspaces.module

Provides information about a runtime extension service of a module to the hosting environment in which the module is running.

IModuleSettings - Interface in com.sap.workspaces.module.settings

Provides access to the configuration properties of a module instance at runtime

IModuleSettingsFactory - Interface in com.sap.workspaces.module.settings

Provides a method to retrieve the module settings (properties).

IModuleStorage - Interface in com.sap.workspaces.module.storage

Provides storage for the runtime content of a module instance

IModuleStorageFactory - Interface in com.sap.workspaces.module.storage

Enables storage and retrieval of the module instance's runtime content.

IModuleTransport - Interface in com.sap.workspaces.module.extension

Provides callback methods that are invoked during the workspace transport; implement them to export or import the module's external resources, such as documents or records.

IModuleTransport.IExportEntry - Interface in com.sap.workspaces.module.extension

Implement the callback methods for exporting of the module's external resources.

IModuleTransport.IImportEntry - Interface in com.sap.workspaces.module.extension

Implement the callback methods for importing of the module's external resources.

importEntries(IModuleContext, IModuleTransport.IImportEntry[]) - Method in interface com.sap.workspaces.module.extension.IModuleTransport

A callback invoked after a workspace in imported.

INavigationTarget - Interface in com.sap.workspaces

Represents an UI element that client can navigate to.

INTERNAL_ERROR - Static variable in exception com.sap.workspaces.WorkspacesRuntimeException

IPage - Interface in com.sap.workspaces.workspace

Provides information about a workspace page

IPersonalTemplate - Interface in com.sap.workspaces.workspace

Provides information about the template used for the user's personal workspace

IPrincipalLifecycle - Interface in com.sap.workspaces.module.extension

Provides callback methods that are invoked when a principal (role, user or group) is added to or removed from the workspace in which the module is running.

IRole - Interface in com.sap.workspaces.workspace

Provides tools for the management of users in the specific workspace role

IRuntimeExtension - Interface in com.sap.workspaces.module

Provides information about a runtime extension service of a module.

ISearchResults - Interface in com.sap.workspaces.directory

Contains the results of workspace search

isManager(IUser) - Method in interface com.sap.workspaces.workspace.IMemberList

Checks if the specified user is a manager in this workspace

isReadOnly() - Method in interface com.sap.workspaces.module.settings.property.IBaseModuleProperty

Determines whether this property is read-only or not.

isUserInRole(IUser, Role) - Method in interface com.sap.workspaces.directory.IWorkspaceDirectory

Checks whether the specified user is in the specified role, such as workspace content administrator.

isUserInRole(IPrincipal) - Method in interface com.sap.workspaces.workspace.IRole

Checks if the specified user is in this role

IWorkspace - Interface in com.sap.workspaces.workspace

Provides access to the workspace information and member list

IWorkspaceDirectory - Interface in com.sap.workspaces.directory

Enables retrieval of the workspace metadata

IWorkspaceFactory - Interface in com.sap.workspaces.workspace

Provides access to workspace operations

IWorkspacesRuntime - Interface in com.sap.workspaces

Workspaces runtime enable retrieval of Enterprise Spaces services and UIs

IWorkspacesService - Interface in com.sap.workspaces

Marker interface to Enterprise Spaces services

L

LIFECYCLE - Static variable in class com.sap.workspaces.module.extension.ExtensionType

M

MANAGER - Static variable in class com.sap.workspaces.workspace.WorkspaceRole

Workspace manager

MAX_RESULTS - Static variable in class com.sap.workspaces.directory.SearchControl

Maximal value of max search results

MEMBER - Static variable in class com.sap.workspaces.workspace.WorkspaceRole

Workspace member

MemberListException - Exception in com.sap.workspaces.workspace

Enumeration of the member list runtime exceptions

MemberListException(String, Throwable) - Constructor for exception com.sap.workspaces.workspace.MemberListException

MODULE_ATTRIBUTE_PERMISSIONS - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

"permissions" attribute of the module configuration-property

MODULE_ATTRIBUTE_WORKSPACE_MANAGER_PERMISSIONS - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

"workspaceManagerPermissions" attribute of the module configuration-property

MODULE_COLSPAN - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Framework property "widthColSpan"

MODULE_CONFIGURATION_PREFIX - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Module configuration property prefix

MODULE_CREATION_FAILED - Static variable in class com.sap.workspaces.TargetKey

The workspace page loaded a deleted module

MODULE_DELETED - Static variable in class com.sap.workspaces.TargetKey

The workspace page loaded a deleted module

MODULE_INSTANCE_ID - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Framework property "instance ID"

MODULE_METADATA_DEPENDENCY_PREFIX - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Module meta-data "dependency" prefix

MODULE_METADATA_EXTENSION_LIFECYCLE - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Module meta-data "extension lifecycle" property

MODULE_METADATA_EXTENSION_PREFIX - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Module meta-data "extension" prefix

MODULE_METADATA_EXTENSION_PRINCIPAL - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Module meta-data "extension principal" property

MODULE_METADATA_EXTENSION_SETTINGS - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Module meta-data "extension settings" property

MODULE_METADATA_EXTENSION_TRANSPORT - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Module meta-data "extension transport" property

MODULE_NAMESPACE - Static variable in interface com.sap.workspaces.module.extension.Constants

MODULE_NAMESPACE_LIFECYCLE - Static variable in interface com.sap.workspaces.module.extension.Constants

MODULE_NAMESPACE_PRINCIPAL - Static variable in interface com.sap.workspaces.module.extension.Constants

MODULE_NAMESPACE_QUOTA - Static variable in interface com.sap.workspaces.module.extension.Constants

MODULE_NAMESPACE_SETTINGS - Static variable in interface com.sap.workspaces.module.extension.Constants

MODULE_NAMESPACE_TRANSPORT - Static variable in interface com.sap.workspaces.module.extension.Constants

MODULE_PLACEHOLDER - Static variable in class com.sap.workspaces.TargetKey

Template module display iView

MODULE_PROPERTY_IDS_FOR_SETTING - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Framework property "propertyIdsFroSetting".

MODULE_TEMPLATE_DELETED - Static variable in class com.sap.workspaces.TargetKey

The workspace page loaded a module that it template was deleted

MODULE_TITLE - Static variable in interface com.sap.workspaces.module.IModuleRuntimeConstants

Framework property "Title"

MODULE_WITH_CUSTOM_PERMISSIONS_IN_PLACEHOLDER - Static variable in class com.sap.workspaces.TargetKey

Template module display iView

ModuleHelper - Class in com.sap.workspaces.module

A helper class for simple retrieval of a module context.

ModuleHelper() - Constructor for class com.sap.workspaces.module.ModuleHelper

ModuleLifecycleException - Exception in com.sap.workspaces.module.extension

An exception that is thrown when a module lifecycle event fails.

ModuleLifecycleException(String, Throwable) - Constructor for exception com.sap.workspaces.module.extension.ModuleLifecycleException

N

name - Variable in class com.sap.workspaces.directory.WorkspaceInfo

NAME_ASCENDING - Static variable in class com.sap.workspaces.directory.SortBy

Sort by workspace name in the ascending order

NAME_DESCENDING - Static variable in class com.sap.workspaces.directory.SortBy

Sort by workspace name in the descending order

navigationTarget - Variable in class com.sap.workspaces.directory.WorkspaceInfo

NO_PERMISSIONS - Static variable in exception com.sap.workspaces.workspace.MemberListException

The user has no permissions to perform an operation

NO_WORKSPACE_ACCESS - Static variable in exception com.sap.workspaces.workspace.MemberListException

The user cannot access workspaces

NOT_A_MEMBER - Static variable in exception com.sap.workspaces.workspace.MemberListException

The user is not a member of the workspace

O

onAddPrincipal(PrincipalInfo, IModuleContext) - Method in interface com.sap.workspaces.module.extension.IPrincipalLifecycle

Called when a principal is added to the workspace

onChangeSettings(IModuleContext, ChangedSetting[]) - Method in interface com.sap.workspaces.module.extension.IModuleLifecycle

A callback invoked when one or more settings of a module instance are modified.

onCreate(IModuleContext) - Method in interface com.sap.workspaces.module.extension.IModuleLifecycle

A callback invoked when a module instance is created and added to a workspace.

onDelete(IModuleContext) - Method in interface com.sap.workspaces.module.extension.IModuleLifecycle

A callback invoked when a module instance is removed from workspace.

ONLY_PORTAL_CONTENT_ADMIN - Static variable in class com.sap.workspaces.TargetKey

The user with no portal content admin role is not allowed

onRemovePrincipal(PrincipalInfo, IModuleContext) - Method in interface com.sap.workspaces.module.extension.IPrincipalLifecycle

Called when a principal is removed from the workspace

OR - Static variable in class com.sap.workspaces.directory.SearchMethod

combine by OR

owner - Variable in class com.sap.workspaces.directory.WorkspaceInfo

P

PAGE_DOES_NOT_EXIST - Static variable in class com.sap.workspaces.TargetKey

The user tried to access a page that either was deleted or never existed

PENDING - Static variable in class com.sap.workspaces.workspace.WorkspaceRole

User that has requested to join a restricted workspace

permissionPolicy - Variable in class com.sap.workspaces.directory.WorkspaceInfo

PermissionPolicy - Class in com.sap.workspaces.workspace

Enumeration of the permission policies that can be applied to a workspace

PermissionPolicy(String) - Constructor for class com.sap.workspaces.workspace.PermissionPolicy

Constructs a new PermissionPolicy type

PERSONAL - Static variable in class com.sap.workspaces.workspace.Type

Personal workspace

PRINCIPAL - Static variable in class com.sap.workspaces.module.extension.ExtensionType

PrincipalInfo - Class in com.sap.workspaces.module.extension

PrincipalInfo(WorkspaceRole, String) - Constructor for class com.sap.workspaces.module.extension.PrincipalInfo

PRIVATE - Static variable in class com.sap.workspaces.workspace.PermissionPolicy

Private workspace: available to a limited group of users, other users cannot request to join; new members are explicitly added by workspace owner or managers

PUBLIC - Static variable in class com.sap.workspaces.workspace.PermissionPolicy

Public workspace: available to everybody

PUBLISHED - Static variable in class com.sap.workspaces.workspace.Status

The workspace is created and published

Q

QUOTA - Static variable in class com.sap.workspaces.module.extension.ExtensionType

R

removeGroup(IUser, IGroup) - Method in interface com.sap.workspaces.workspace.IRole

Removes the specified group from the role

removeUser(IUser, IUser) - Method in interface com.sap.workspaces.workspace.IRole

Removes the specified user from the role

RESTRICTED - Static variable in class com.sap.workspaces.workspace.PermissionPolicy

Restricted workspace: available to a limited group of users, other users can request to join

Role - Class in com.sap.workspaces.directory

Enumeration of the portal user roles in enterprise workspaces

Role(String) - Constructor for class com.sap.workspaces.directory.Role

RuntimeFactory - Class in com.sap.workspaces

The RuntimeFactory is the entry point for all Enterprise Spaces clients - UI applications, modules etc

RuntimeFactory() - Constructor for class com.sap.workspaces.RuntimeFactory

S

saveModuleSettings(IModuleSettings) - Method in interface com.sap.workspaces.module.settings.IModuleSettingsFactory

Saves the specified module settings

search(SearchControl) - Method in interface com.sap.workspaces.directory.IWorkspaceDirectory

Search for workspaces according to the specified parameters.

SearchControl - Class in com.sap.workspaces.directory

Defines search conditions of the IWorkspaceDirectory.search(SearchControl) method.

SearchControl() - Constructor for class com.sap.workspaces.directory.SearchControl

SearchFilter - Class in com.sap.workspaces.directory

Defines additional search conditions for IWorkspaceDirectory.search(SearchControl) method.

SearchFilter() - Constructor for class com.sap.workspaces.directory.SearchFilter

SearchMethod - Class in com.sap.workspaces.directory

Defines how to combine the search conditions defined in SearchFilter

SearchMethod(String) - Constructor for class com.sap.workspaces.directory.SearchMethod

setBinaryProperty(String, InputStream) - Method in interface com.sap.workspaces.module.storage.IModuleStorage

Defines the value of the specified binary property: updates the value of the existing property, or creates the new property.

setDescription(String) - Method in class com.sap.workspaces.directory.SearchFilter

Defines the workspace description to search for

setDescription(String) - Method in class com.sap.workspaces.workspace.TemplateInfo

Defines the template description

setDescription(String) - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Defines the workspace description

setErrorCode(String) - Method in exception com.sap.workspaces.WorkspacesRuntimeException

Set the error code that specifies the reason of failure

setExcludedWorkspaces(WorkspaceInfo[]) - Method in class com.sap.workspaces.directory.SearchControl

Defines the workspaces that should be excluded from the search results.

setID(String) - Method in class com.sap.workspaces.module.extension.PrincipalInfo

Defines the role ID

setIdentifier(IIdentifier) - Method in class com.sap.workspaces.workspace.TemplateInfo

Defines the template identifier

setLocale(Locale) - Method in class com.sap.workspaces.directory.SearchFilter

Defines the search language according to the user's locale

setLocale(Locale) - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Defines the master locale of the workspace

setMaxResults(int) - Method in class com.sap.workspaces.directory.SearchControl

Defines the maximum number of workspaces to return as a result of the search.

setName(String) - Method in class com.sap.workspaces.directory.SearchFilter

Defines the workspace name to search for

setName(String) - Method in class com.sap.workspaces.workspace.TemplateInfo

Defines the template name

setName(String) - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Defines the workspace name

setOwner(String) - Method in class com.sap.workspaces.directory.SearchFilter

Defines the workspace owner to search for

setOwner(IUser, IUser) - Method in interface com.sap.workspaces.workspace.IMemberList

Assigns workspace ownership

setOwners(String[]) - Method in class com.sap.workspaces.directory.SearchFilter

Defines the list of login names of the workspace owners

setPermissionPolicies(PermissionPolicy[]) - Method in class com.sap.workspaces.directory.SearchControl

Defines which workspace permission policies to include in the search, such as PermissionPolicy.PUBLIC or PermissionPolicy.RESTRICTED.

setPermissionPolicy(PermissionPolicy) - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Defines the workspace permission policy

setProperty(String, String) - Method in interface com.sap.workspaces.module.storage.IModuleStorage

Defines the value of the specified string property: updates the value of the existing property, or creates the new property.

setSearchFilter(SearchFilter) - Method in class com.sap.workspaces.directory.SearchControl

Sets a SearchFilter object that defines additional search parameters.

setSearchMethod(SearchMethod) - Method in class com.sap.workspaces.directory.SearchFilter

Defines the search method, either SearchMethod.AND (default) or SearchMethod.OR

setSortBy(SortBy) - Method in class com.sap.workspaces.directory.SearchControl

Defines the sort order of the search results.

setStartFrom(int) - Method in class com.sap.workspaces.directory.SearchControl

Defines the sequential number of the search result from which to start returning results.

setStatus(IUser, Status, String) - Method in interface com.sap.workspaces.workspace.IWorkspace

Defines the workspace status

setTemplateID(String) - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Defines the workspace template ID

SETTINGS - Static variable in class com.sap.workspaces.module.extension.ExtensionType

setValue(String) - Method in interface com.sap.workspaces.module.settings.property.IBaseModuleProperty

Defines the value of the property.

setWorkspaceRole(WorkspaceRole) - Method in class com.sap.workspaces.module.extension.PrincipalInfo

Defines the workspace role

SHARED - Static variable in class com.sap.workspaces.workspace.Type

Shared workspace

SortBy - Class in com.sap.workspaces.directory

Defines the sort order of search results

SortBy(String) - Constructor for class com.sap.workspaces.directory.SortBy

status - Variable in class com.sap.workspaces.directory.WorkspaceInfo

Status - Class in com.sap.workspaces.workspace

Enumeration of the shared workspace statuses

Status(String) - Constructor for class com.sap.workspaces.workspace.Status

Constructs a new Status

T

TargetKey - Class in com.sap.workspaces

Enumeration to hold all supported navigation targets

TargetKey(String) - Constructor for class com.sap.workspaces.TargetKey

Constructs a new TargetKey

TemplateInfo - Class in com.sap.workspaces.workspace

Provides information about the template

TemplateInfo() - Constructor for class com.sap.workspaces.workspace.TemplateInfo

TIMEOUT - Static variable in exception com.sap.workspaces.WorkspacesRuntimeException

toString() - Method in class com.sap.workspaces.directory.Role

toString() - Method in class com.sap.workspaces.directory.SearchControl

toString() - Method in class com.sap.workspaces.directory.SearchFilter

toString() - Method in class com.sap.workspaces.directory.SearchMethod

toString() - Method in class com.sap.workspaces.directory.SortBy

toString() - Method in class com.sap.workspaces.module.extension.ExtensionType

toString() - Method in class com.sap.workspaces.TargetKey

toString() - Method in class com.sap.workspaces.workspace.PermissionPolicy

toString() - Method in class com.sap.workspaces.workspace.Status

toString() - Method in class com.sap.workspaces.workspace.Type

toString() - Method in class com.sap.workspaces.workspace.WorkspaceRole

TRANSPORT - Static variable in class com.sap.workspaces.module.extension.ExtensionType

Type - Class in com.sap.workspaces.workspace

Enumeration of the workspace types

Type(String) - Constructor for class com.sap.workspaces.workspace.Type

Constructs a new Type

TYPE_BINARY - Static variable in interface com.sap.workspaces.module.storage.IModuleStorage

TYPE_STRING - Static variable in interface com.sap.workspaces.module.storage.IModuleStorage

TYPE_UNKNOWN - Static variable in interface com.sap.workspaces.module.storage.IModuleStorage

U

update(WorkspaceProperties, IUser) - Method in interface com.sap.workspaces.workspace.IWorkspace

Updates the workspace properties

V

value - Variable in class com.sap.workspaces.module.extension.ExtensionType

valueOf(String) - Static method in class com.sap.workspaces.directory.SortBy

valueOf(String) - Static method in class com.sap.workspaces.workspace.PermissionPolicy

Returns the permission policy specified by a string value

valueOf(String) - Static method in class com.sap.workspaces.workspace.Status

Converts the specified string value to the workspace status

valueOf(String) - Static method in class com.sap.workspaces.workspace.Type

Converts the specified string value to the workspace type

W

WORKSPACE_CLOSED - Static variable in class com.sap.workspaces.TargetKey

The user tried to access a closed workspace

WORKSPACE_DIRECTORY - Static variable in class com.sap.workspaces.TargetKey

The workspace directory view

WORKSPACE_DOES_NOT_EXIST - Static variable in class com.sap.workspaces.TargetKey

The user tried to access a workspace that either was deleted, never existed or is private

WORKSPACE_IS_CLOSED - Static variable in exception com.sap.workspaces.workspace.MemberListException

The workspace is closed

WORKSPACE_IS_PUBLIC - Static variable in exception com.sap.workspaces.workspace.MemberListException

A public workspace is open for all, no need to join

WORKSPACE_RESTRICTED - Static variable in class com.sap.workspaces.TargetKey

The user tried to access a restricted workspace

WORKSPACE_SETTINGS - Static variable in class com.sap.workspaces.TargetKey

The shared WS settings view

WorkspaceInfo - Class in com.sap.workspaces.directory

Data object through which you read the workspace properties

WorkspaceInfo() - Constructor for class com.sap.workspaces.directory.WorkspaceInfo

WorkspaceProperties - Class in com.sap.workspaces.workspace

Data object through which you set the workspace properties when creating a new workspace or updating an existing one

WorkspaceProperties() - Constructor for class com.sap.workspaces.workspace.WorkspaceProperties

workspaceRole - Variable in class com.sap.workspaces.module.extension.PrincipalInfo

WorkspaceRole - Class in com.sap.workspaces.workspace

Enumeration of the user roles in a workspace

WorkspaceRole(String) - Constructor for class com.sap.workspaces.workspace.WorkspaceRole

Constructs a new WorkspaceRole type

WORKSPACES_ACCESS - Static variable in class com.sap.workspaces.directory.Role

Users in this role can access workspaces

WORKSPACES_CONTENT_ADMIN - Static variable in class com.sap.workspaces.directory.Role

Users in this role can perform workspace content administration tasks

WORKSPACES_PERSONAL_OWNER - Static variable in class com.sap.workspaces.directory.Role

Users in this role can create personal workspaces

WORKSPACES_SHARED_CREATION - Static variable in class com.sap.workspaces.directory.Role

Users in this role can create shared workspaces

WORKSPACES_SYSTEM_ADMIN - Static variable in class com.sap.workspaces.directory.Role

Users in this role can perform workspace system administration tasks

WorkspacesRuntimeException - Exception in com.sap.workspaces

Enterprise workspaces base exception

WorkspacesRuntimeException(String, Throwable) - Constructor for exception com.sap.workspaces.WorkspacesRuntimeException

Constructs a new workspace runtime exception with the specified detail message and cause.

writeEntryData(OutputStream) - Method in interface com.sap.workspaces.module.extension.IModuleTransport.IExportEntry

Saves entries to the output stream

A C D E G H I L M N O P Q R S T U V W