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

A

AbstractApprovalRequest - Class in com.sap.workspaces.workspace

Extend this class to implement approval of a newly created workspace

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

AbstractContentProvider - Class in com.sap.workspaces.content

Extend this abstract class to integrate external content in workspaces

AbstractContentProvider() - Constructor for class com.sap.workspaces.content.AbstractContentProvider

AbstractExpiration - Class in com.sap.workspaces.workspace

Extend this class to perform actions upon workspace expiration

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

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

Extend this class to implement export of the module resources.

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

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

* Use this class to import the module resources, such as files, from a transport package..

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

AbstractIndexItem - Class in com.sap.workspaces.indexing

Extend this class to represent the textual data of a workspace item for the purposes of indexing

AbstractIndexItem() - Constructor for class com.sap.workspaces.indexing.AbstractIndexItem

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

Extend this class to enable adding links to a module

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

AbstractModule - Class in com.sap.workspaces.content

Extend this abstract class to represent a module instance.

AbstractModule() - Constructor for class com.sap.workspaces.content.AbstractModule

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

Extend this class to enable indexing of the module data

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

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

Extend this class by implementing the callback methods invoked when the module is added to or removed from a workspace, or the module settings are changed

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

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

Extend this class to ensure that module resources (such as external files, associated with the module) are included in the workspace transport package.

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

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

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

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

AbstractPrincipalLifecycle - Class 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.

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

ADD_LINKS - Static variable in class com.sap.workspaces.module.extension.AbstractLink

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

Adds the specified group to the role

addLink(IModuleContext, LinkInfo) - Method in class com.sap.workspaces.module.extension.AbstractLink

A callback invoked when the specified link is added to the module

addModule(IUser, String, String) - Method in interface com.sap.workspaces.workspace.IPage

Adds a workspace module or an external content item as a module to the page

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

APPLICATION_LIST - Static variable in class com.sap.workspaces.content.Availability

Applications in the Link Gallery

approve(boolean, IUser, IWorkspace, String) - Method in interface com.sap.workspaces.workspace.IApproval

Call to approve or reject a newly created workspace

assertWriteProtectOff() - Method in interface com.sap.workspaces.authoring.IWriteProtectMode

Throws a runtime exception if the PCD is in write-protect mode; call this method if you want to handle this exception

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"

Availability - Class in com.sap.workspaces.content

Defines constants that indicate availability of the content item in the content galleries, such as Module Gallery and Link Gallery

C

canApprove(IUser, IUser) - Method in class com.sap.workspaces.workspace.AbstractApprovalRequest

Verifies that the approver is authorized to approve the request

canEdit(IUser, IWorkspace) - Method in interface com.sap.workspaces.authoring.IWorkspaceAuthoring

Checks whether the current user can edit the specified workspace

canPublish(IUser, IWorkspace) - Method in interface com.sap.workspaces.authoring.IWorkspaceAuthoring

Checks whether the current user can publish the specified workspace

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

categoryID - Variable in class com.sap.workspaces.workspace.WorkspaceCategory

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

Provides information about a changed runtime setting of a module’s property

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.authoring - package com.sap.workspaces.authoring

Provides information related to workspace authoring

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

Provides tools that enable you to integrate and manage external content in workspaces

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

Provides access to the functionality of workspace directory

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

Enables you to prepare workspace content for indexing by search engines

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

Provides access to available page layouts for the purposes of integration in the Layouts panel

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

Provides access to the runtime data of a module.

com.sap.workspaces.module.extension - package 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 - package com.sap.workspaces.module.settings

Provides access to the runtime settings of the configuration properties of a module instance.

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

Provides access to the runtime setting of module properties

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

Enables storage and retrieval of the runtime content of a module instance.

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

Provides tools to access workspace data, such as properties, roles, pages, categories 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; default value is true

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

contentDeleted(String, String) - Method in interface com.sap.workspaces.content.IContentProviderEvents

Raises an event when content is deleted

ContentDescriptor - Class in com.sap.workspaces.content

Provides a descriptor of a content item for the purposes of its integration in the content galleries and instantiation on a page

ContentDescriptor(String, String, String, String, String[], Date, String) - Constructor for class com.sap.workspaces.content.ContentDescriptor

Constructor of the content descriptor

ContentFilter - Class in com.sap.workspaces.content

Allows filtering content items according to their availability in the content galleries and workspaces

ContentFilter(Availability[], Type[]) - Constructor for class com.sap.workspaces.content.ContentFilter

ContentProviders - Class in com.sap.workspaces.content

Contains constants defining the IDs of the SAP content providers Content Provider ID should not exceed 32 characters

ContentProviders() - Constructor for class com.sap.workspaces.content.ContentProviders

contentUpdated(String, String) - Method in interface com.sap.workspaces.content.IContentProviderEvents

Raises an event when content is updated

create(ItemInfo) - Static method in class com.sap.workspaces.indexing.ItemInfo

Create a new instance of ItemInfo from another ItemInfo

create(IIdentifier, String, String) - Static method in class com.sap.workspaces.indexing.ItemInfo

Create a new instance of ItemInfo, based on the specified parameters

create(IIdentifier, String) - Static method in class com.sap.workspaces.indexing.ItemInfo

Create a new instance of ItemInfo, based on the specified parameters

create(IIdentifier) - Static method in class com.sap.workspaces.indexing.ItemInfo

Create a new instance of ItemInfo, based on the specified parameters

create() - Static method in class com.sap.workspaces.indexing.ItemInfo

Create a new instance of ItemInfo

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

Create personal workspace

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

Create shared workspace

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

createItemInfoFromIndexingURL(String) - Static method in class com.sap.workspaces.indexing.ItemInfoHelper

Parses the specified URL and converts it into an ItemInfo:
If the URL starts with 'workspaces' prefix, the prefix is ignored.

createModuleItemInfo(IModuleContext) - Static method in class com.sap.workspaces.indexing.ItemInfoHelper

Creates an ItemInfo object of the module instance.

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

Creates a workspace page

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

Creates a personal workspace for the specified user

createResourceIndexingURL(ItemInfo, String, Map) - Static method in class com.sap.workspaces.indexing.ItemInfoHelper

Creates the URL for indexing of the specified module resource related to the specified ItemInfo.

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

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

Deletes a workspace page

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

Deletes the specified property

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

DOCUMENT_LIST - Static variable in class com.sap.workspaces.indexing.ItemType

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

he workspace is created but not published

E

EMPTY_MODULE_RESOURCE_PARAMTERS - Static variable in class com.sap.workspaces.indexing.ItemInfo

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

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.indexing.ItemType

Compares 2 URLTypes

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

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

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

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

EXISTING_LOCK - Static variable in class com.sap.workspaces.module.LockInfo.LockState

The lock on the module for the current user has been renewed

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

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

F

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

Forces lock on the specified module for the current user, regardless of the module’s locking status

G

GALLERY - Static variable in class com.sap.workspaces.content.Availability

Module Gallery

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

Returns the user who has approved this workspace; relevant only if the customer has implemented workspace approval flow

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

Returns the specified attribute of the property, or null, if the attribute is not found

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

Returns 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

getCategories() - Method in class com.sap.workspaces.content.ContentDescriptor

Returns an array of the module categories to which this content item belongs

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

Returns an array of workspace categories included in the search

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

Returns an array of workspace categories included in the search

getCategories(IUser) - Method in interface com.sap.workspaces.workspace.ICategories

Returns an array of all workspace categories defined in the system

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

Returns the categories assigned to the workspace

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

Returns the workspace categories assigned to the template

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

Returns the categories assigned to the workspace

getCategoriesInUse(Type[], PermissionPolicy[], Status[]) - Method in interface com.sap.workspaces.workspace.ICategories

Returns an array of IDs of the categories used in the workspaces that match the specified conditions

getCategory(IUser, String) - Method in interface com.sap.workspaces.workspace.ICategories

Returns the specified workspace category

getCategoryID() - Method in class com.sap.workspaces.workspace.WorkspaceCategory

Returns the ID of the category

getChildren() - Method in class com.sap.workspaces.indexing.AbstractIndexItem

Currently not supported

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

Returns the value of the specified configuration key

getContent(IPortalComponentRequest) - Method in class com.sap.workspaces.content.AbstractModule

Depending on the module's isolation mode, returns: if isolated, the URL of the module; if embedded, the HTML markup of the module content

getContentAvailability() - Method in class com.sap.workspaces.content.ContentFilter

Returns the content galleries in which the content item should be available

getContentDescriptor(String, IUser, Locale) - Method in class com.sap.workspaces.content.AbstractContentProvider

Returns the descriptor of the content item specified by the content ID, user and locale

getContentDescriptors(ContentFilter, IUser, Locale) - Method in class com.sap.workspaces.content.AbstractContentProvider

Returns descriptors of the content items specified by the content filter, user and locale

getContentForIndexing() - Method in class com.sap.workspaces.content.AbstractModule

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.

getContentID() - Method in class com.sap.workspaces.content.ContentDescriptor

Returns the ID of the content item in its source system; should not exceed 340 characters

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

Returns the content provider ID

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

getCreationDate() - Method in class com.sap.workspaces.content.ContentDescriptor

Optional; returns the date when this content item was created in the source system; if not specified, the null value is passed

getDescription() - Method in class com.sap.workspaces.content.ContentDescriptor

Returns the content item's description

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 class com.sap.workspaces.indexing.AbstractIndexItem

Returns the item description

getDescription() - Method in class com.sap.workspaces.layout.LayoutDescriptor

Returns the description of the layout

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

Returns an error code that specifies the reason of failure

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

Returns the workspaces to be excluded from the search

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

Returns the expiration date of the workspace

getExportEntries(IModuleContext) - Method in class com.sap.workspaces.module.extension.AbstractModuleTransport

Called before the workspace is exported. returns an array of entries to export

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

Deprecated. 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

getHeight() - Method in class com.sap.workspaces.module.extension.ViewOption

Returns the height of the new window in which to launch the view

getIconURL() - Method in class com.sap.workspaces.content.ContentDescriptor

Returns the URL of the icon associated with the content item

getIconURL() - Method in class com.sap.workspaces.layout.LayoutDescriptor

Returns the URL of the icon associated with the layout

getID() - Method in class com.sap.workspaces.content.AbstractContentProvider

Returns the content provider ID; should not exceed 32 characters

getID() - Method in class com.sap.workspaces.content.AbstractModule

Returns the module ID

getId() - Method in class com.sap.workspaces.module.extension.AbstractExportEntry

Returns the ID of an entry

getId() - Method in class com.sap.workspaces.module.extension.AbstractImportEntry

Returns the ID of an entry

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

Deprecated. Returns the ID of an entry

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

Deprecated. Returns the ID of an entry

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

Returns the UME role ID

getID() - Method in interface com.sap.workspaces.module.IModuleTemplateContext

Returns the module template 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.ICategory

Returns the ID of the category

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

Returns the ID of the category value, which is used to assign the category value to a workspace

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 PCD path

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

Returns the template identifier

getIndexingURL(ItemInfo) - Static method in class com.sap.workspaces.indexing.ItemInfoHelper

Creates the URL of the specified InfoItem for indexing.

getIndexItem(IModuleContext, ItemInfo) - Method in class com.sap.workspaces.module.extension.AbstractModuleIndexData

Provides the module data for indexing; invoked, for example, when the module content has changed.

getInitialView(IModuleContext) - Method in class com.sap.workspaces.module.extension.AbstractModuleViewOptions

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

getInputStream() - Method in class com.sap.workspaces.module.extension.AbstractImportEntry

Returns the input stream

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

Deprecated. Returns input stream

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

Returns the module instance ID

getItemInfo() - Method in class com.sap.workspaces.indexing.AbstractIndexItem

Returns an ItemInfo object for this item

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

Returns the key of the setting that has been changed

getLabel() - Method in class com.sap.workspaces.module.extension.ViewOption

Returns the option's label in the tray menu

getLaunchMode() - Method in class com.sap.workspaces.module.extension.ViewOption

Defines how to launch the view: in place or in a new window

getLayoutID() - Method in class com.sap.workspaces.layout.LayoutDescriptor

Returns the ID of the layout

getLayouts(Locale, IUser) - Method in interface com.sap.workspaces.layout.ILayouts

Returns available page layouts

getLayoutXML() - Method in class com.sap.workspaces.layout.LayoutDescriptor

Returns an XML representation of the layout

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

Deprecated. As of 1.1, no need to use

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

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

Returns the locking status of the specified module context

getLockingUserId() - Method in class com.sap.workspaces.module.LockInfo

getLockingUserName() - Method in class com.sap.workspaces.module.LockInfo

getMaxNumberOfPages(IUser, IWorkspace) - Method in interface com.sap.workspaces.authoring.IWorkspaceAuthoring

Returns the maximum number of pages in the specified workspace

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

Returns the maximum number of workspaces to return as search results

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

Returns the member list of the workspace

getModule(String, IUser) - Method in class com.sap.workspaces.content.AbstractContentProvider

Returns a module created from the specified content item

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, Locale) - Method in interface com.sap.workspaces.module.IModuleContextFactory

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

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

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

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

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

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

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

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

Returns the module context specified by the current request

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

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

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

Deprecated. Returns the module context specified by the workspace ID, module instance ID and user, in the original locale

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

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

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

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

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

Returns the module context

getModuleID() - Method in class com.sap.workspaces.indexing.ItemInfo

Returns the ID of the module instance

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

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

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

Returns an array of module IDs of all modules in the page

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

Deprecated. use IPage.getModuleIdentifiers() instead. 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 settings for the specified module context

getName(Locale) - Method in class com.sap.workspaces.content.AbstractModule

Returns the module's name

getName() - Method in class com.sap.workspaces.content.ContentDescriptor

Returns the content item's name that appears in the content galleries

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 class com.sap.workspaces.indexing.AbstractIndexItem

Returns the item name

getName() - Method in class com.sap.workspaces.layout.LayoutDescriptor

Returns the name of the layout

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(Locale) - Method in interface com.sap.workspaces.workspace.ICategory

Returns the name of the category for the specified locale

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

Returns the name of the category value for the specified locale

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

Deprecated. use WorkspaceInfo.getNavigationTargetURL()

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

Returns the navigation target for the specified key

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

Returns the page navigation target

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

Deprecated. use IWorkspace.getNavigationTargetURL()

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

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

getNavigationTargetURL() - 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 owner 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

getPageID() - Method in class com.sap.workspaces.indexing.ItemInfo

Returns the ID of the page

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 workspace permission policies, such as public or restricted, to include in the search,

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

Returns workspace permission policies, such as public or restricted, to include in the count,

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

getPosition() - Method in class com.sap.workspaces.module.extension.ViewOption

Returns the option's position in the tray menu

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

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

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

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

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

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

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

Returns an array of all attributes of the specified 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.IModuleTemplateContext

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

Returns the type of the specified property

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

Returns the quick link to the workspace

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

Returns the workspace name

getQuota() - Method in interface com.sap.workspaces.workspace.IQuota

Returns the space usage quota of the workspace

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

Returns the space usage quota of the workspace

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

Returns an implementation of the specified service interface

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

Returns an array of existing implementations of the specified service interface, if the service interface has multiple implementations; similar to IWorkspacesRuntime.getService(Class)

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

getSpaceUsage() - Method in interface com.sap.workspaces.workspace.IQuota

Returns the space used by the workspace

getSpaceUsageLastUpdate() - Method in interface com.sap.workspaces.workspace.IQuota

Returns the date when the space usage was last updated

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

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

getState() - Method in class com.sap.workspaces.module.LockInfo

getState() - Method in class com.sap.workspaces.module.LockInfo.LockState

Returns the locking status of the module

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

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

Returns an array of workspace statuses to include in the search, such as published, draft, closed or pending

getStatuses() - Method in class com.sap.workspaces.directory.WorkspaceFilter

Returns an array of workspace statuses to include in the count, such as published, draft, closed or pending

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

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

getTargetKey() - Method in class com.sap.workspaces.module.extension.ViewOption.ViewInfo

Return the target key to the screen

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 available for the specified workspace type

getTexts() - Method in class com.sap.workspaces.indexing.AbstractIndexItem

Returns the item textual content in an array;

getThreshold() - Method in interface com.sap.workspaces.workspace.IQuota

Returns the quota threshold of the workspace

getTitle() - Method in class com.sap.workspaces.module.extension.LinkInfo

Returns the title of the link

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

Returns the total number of search results

getType() - Method in class com.sap.workspaces.indexing.AbstractIndexItem

Returns the string representation of the item type defined by a custom implementation for the purposes of indexing return The item type

getType() - Method in class com.sap.workspaces.module.extension.ViewOption.ViewInfo

Return the type of the module view

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

Returns the workspace type, such as shared or personal

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

Returns an array of workspace types to include in the search, such as shared or personal

getTypes() - Method in class com.sap.workspaces.directory.WorkspaceFilter

Returns an array of workspace types to include in the count, such as shared or personal

getURL() - Method in class com.sap.workspaces.content.ContentDescriptor

Returns the navigation URL of this content item

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

Returns the navigation target URL The URL contains a prefix that indicates its type, such as “pcd:” or “http:”

getUrl() - Method in class com.sap.workspaces.module.extension.LinkInfo

Returns the URL of the link

getURL() - Method in class com.sap.workspaces.module.extension.ViewOption.ViewInfo

Return the path to the module view

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

Returns the current user

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

Deprecated. Returns all users in this role - use getUsers(boolean recursive) instead

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

Returns all users in the role

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

Returns all valid values of this property

getValue(String) - Method in interface com.sap.workspaces.IConfiguration

Returns the value of the specified configuration property

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

Returns the value of the property.

getValue(String) - Method in interface com.sap.workspaces.workspace.ICategory

Returns the category value specified by the value ID

getValueIDs() - Method in class com.sap.workspaces.workspace.WorkspaceCategory

Returns the category values assigned to the workspace

getValues(String) - Method in interface com.sap.workspaces.IConfiguration

Returns the values of the specified multi-value configuration property

getValues(Locale) - Method in interface com.sap.workspaces.workspace.ICategory

Returns an array of all values of this category

getViewInfo() - Method in class com.sap.workspaces.module.extension.ViewOption

Returns the module view corresponding to the option

getViewOptions(IModuleContext) - Method in class com.sap.workspaces.module.extension.AbstractModuleViewOptions

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

getWidth() - Method in class com.sap.workspaces.module.extension.ViewOption

Returns the width of the new window in which to launch the view

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

Returns the specified workspace

getWorkspaceAvailability() - Method in class com.sap.workspaces.content.ContentFilter

Returns the workspace types in which the content item should be available

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

Returns the workspace ID

getWorkspaceIdentifier() - Method in class com.sap.workspaces.indexing.ItemInfo

Returns the identifier of the workspace.

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

Returns the workspace role

getWorkspacesCount(IUser, WorkspaceFilter) - Method in interface com.sap.workspaces.directory.IWorkspaceDirectory

Counts workspaces according to the conditions specified by the workspace filter

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

Returns the 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 in a sorted array

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

Returns workspace metadata for the shared workspaces specified by their IDs.

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

Static method to retrieve an instance of the IWorkspacesRuntime service; should be used by applications and modules for access to the screens and services of enterprise workspaces

H

hashCode() - Method in class com.sap.workspaces.content.Availability

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.indexing.ItemType

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

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

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

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

IApproval - Interface in com.sap.workspaces.workspace

Use this service if you implement approval of workspace creation In this case, a newly created shared workspace is set to the Status.PENDING status, and becomes available only after approval

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

Represents a basic module property

ICategories - Interface in com.sap.workspaces.workspace

Provides access to the workspace categories that can be assigned to workspaces

ICategory - Interface in com.sap.workspaces.workspace

Represents a workspace category

ICategoryValue - Interface in com.sap.workspaces.workspace

Represents a workspace category value

IConfiguration - Interface in com.sap.workspaces

Provides access to the configuration properties of enterprise workspaces

IContentProviderEvents - Interface in com.sap.workspaces.content

Enables content items to raise events when their content or internal resources change at runtime

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

ILayouts - Interface in com.sap.workspaces.layout

ILocking - Interface in com.sap.workspaces.module

Provides tools to manage locking of workspace modules

IMemberList - Interface in com.sap.workspaces.workspace

Provides tools for accessing workspace members

IModuleContext - Interface in com.sap.workspaces.module

Represents the runtime context associated with a specific module instance

IModuleContextFactory - Interface in com.sap.workspaces.module

Provides methods to access the runtime context of a module instance.

IModuleEvents - Interface in com.sap.workspaces.module

Enables modules to raise events when their content changes at runtime.

IModuleID - Interface in com.sap.workspaces.module

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

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

Deprecated. use AbstractModuleLifecycle instead

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

Provides access to the module property values

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 module runtime extension service to the hosting environment in which the module is running.

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

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

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

Provides a method to retrieve the runtime settings of module properties The following example illustrates how to access and use the factory:
IWorkspacesRuntime runtime = RuntimeFactory.getWorkspacesRuntime();
IModuleSettingsFactory settingsFactory = runtime.getService(IModuleSettingsFactory.class);
IModuleSettings settings = settingsFactory.getModuleSettings(moduleContext);


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

Enables storage and retrieval of the runtime content of a module instance; the content is stored as a collection of properties

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

Provides tools to maintain storage of the runtime content of a module instance, such as the text content of.a TextPad module.

IModuleTemplateContext - Interface in com.sap.workspaces.module

Provides access to the module template properties

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

Deprecated. use AbstractModuleTransport instead

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

Deprecated. Implement the callback methods for exporting of the module's external resources. An entry in the transport package (zip file) is a file that contains one or more external resources of the module. A module should save its entries to the output stream.

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

Deprecated. Implement the callback methods for importing of the module's external resources. An entry represents a file in the transport zip file that was exported by this module. Modules should read the entries from the input stream and import their external resources.

importEntries(IModuleContext, AbstractImportEntry[]) - Method in class com.sap.workspaces.module.extension.AbstractModuleTransport

Called after a workspace is imported.

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

Deprecated. A callback invoked after a workspace in imported.

IN_PLACE - Static variable in class com.sap.workspaces.module.extension.ViewOption.LaunchMode

Launch target in place

INavigationTarget - Interface in com.sap.workspaces

Represents the navigation target URL of an enterprise workspaces screen that can be replaced by a custom implementation.

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

INDEXING_URL_PREFIX - Static variable in class com.sap.workspaces.indexing.ItemInfoHelper

INTERNAL_ERROR - Static variable in exception com.sap.workspaces.module.extension.LinkException

Could not add the link due to an internal error

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 a personal workspace

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

Deprecated. use AbstractPrincipalLifecycle instead

IQuota - Interface in com.sap.workspaces.workspace

Provides information about the workspace space usage quota and status

IRole - Interface in com.sap.workspaces.workspace

Provides methods for management of users in a 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

isMandatory() - Method in interface com.sap.workspaces.workspace.ICategory

Determines whether the category is mandatory (at least one value of this category has to be assigned to a workspace)

isPagePermanent(IUser, IPage) - Method in interface com.sap.workspaces.authoring.IWorkspaceAuthoring

Checks whether the specified page is permanent (contains at least one module that cannot be deleted)

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

Determines whether the property is read-only

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

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

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

Checks if the specified user is in the role

isWorkspace(String) - Method in interface com.sap.workspaces.authoring.IWorkspaceAuthoring

Checks whether the specified navigation target is a workspace

isWriteProtectMode() - Method in interface com.sap.workspaces.authoring.IWriteProtectMode

Checks whether the PCD is in write-protect mode

ItemInfo - Class in com.sap.workspaces.indexing

Serves as a unique identifier for an a workspace item for the purposes of indexing

ItemInfo(ItemInfo) - Constructor for class com.sap.workspaces.indexing.ItemInfo

ItemInfo(IIdentifier, String, String) - Constructor for class com.sap.workspaces.indexing.ItemInfo

ItemInfo(IIdentifier, String) - Constructor for class com.sap.workspaces.indexing.ItemInfo

ItemInfo(IIdentifier) - Constructor for class com.sap.workspaces.indexing.ItemInfo

ItemInfo() - Constructor for class com.sap.workspaces.indexing.ItemInfo

ItemInfoHelper - Class in com.sap.workspaces.indexing

A helper class for handling of the ItemInfo object

ItemInfoHelper() - Constructor for class com.sap.workspaces.indexing.ItemInfoHelper

ItemType - Class in com.sap.workspaces.indexing

Defines the type of the workspace item for the purposes of indexing.

IVIEW - Static variable in class com.sap.workspaces.module.extension.ViewOption.ViewType

View is an iView

IWorkspace - Interface in com.sap.workspaces.workspace

Provides access to the workspace information and member list

IWorkspaceAuthoring - Interface in com.sap.workspaces.authoring

Provides information related to workspace authoring; can be used for custom implementations of the tabstrip

IWorkspaceDirectory - Interface in com.sap.workspaces.directory

Enables retrieval of workspace metadata

IWorkspaceFactory - Interface in com.sap.workspaces.workspace

Provides access to workspace information and operations

IWorkspacesRuntime - Interface in com.sap.workspaces

Enables retrieval of the services and navigation URLs of the enterprise workspaces screens

IWorkspacesService - Interface in com.sap.workspaces

Marker interface to the services of enterprise workspaces

IWriteProtectMode - Interface in com.sap.workspaces.authoring

For maintenance purposes, the portal periodically goes into write-protect mode.

J

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

Workspace placeholder when user tried to access a restricted workspace while his membership request is still pending

K

KM - Static variable in class com.sap.workspaces.content.ContentProviders

ID of KM content provider

L

LayoutDescriptor - Class in com.sap.workspaces.layout

Provides a descriptor of a page layout for the purposes of its integration in the Layouts panel

LayoutDescriptor(String, String, String, String, String) - Constructor for class com.sap.workspaces.layout.LayoutDescriptor

Constructor of the layout descriptor

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

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

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

The system is in write-protect mode; indicates that a warning message is displayed in place of an original UI

LINK_LIST - Static variable in class com.sap.workspaces.indexing.ItemType

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

An exception thrown when a link cannot be added to a module

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

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

Represents a link that can be added to a module; contains the URL and title of the link

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

Constructor

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

Locks the specified module for the current user.

LOCKED_OBJECT - Static variable in exception com.sap.workspaces.module.extension.LinkException

Could not add the link because the module is locked

LockInfo - Class in com.sap.workspaces.module

Represents the locking status of the module; includes information about the locking user, if the module is locked

LockInfo(LockInfo.LockState, String) - Constructor for class com.sap.workspaces.module.LockInfo

LockInfo.LockState - Class in com.sap.workspaces.module

Represents the locking status of the module

M

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

Workspace manager

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

Max 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

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

Workspace placeholder when user tried to access a workspace with no owner or manager

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_CONTENT_UNAVAILABLE - Static variable in class com.sap.workspaces.TargetKey

Module placeholder when external content of the module is not available

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

Module placeholder when the module could not be created

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

Module placeholder when the module has been deleted

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

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

Framework property "instance ID"

MODULE_IS_LOCKED - Static variable in class com.sap.workspaces.module.LockInfo.LockState

The module is currently locked by another user

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

Module placeholder in maintenance mode

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

Deprecated. use Constants.MODULE_NAMESPACE_LIFECYCLE instead

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

Deprecated. use Constants.MODULE_EXTENSION_PREFIX instead

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

Deprecated. use Constants.MODULE_NAMESPACE_PRINCIPAL instead

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

Deprecated. use Constants.MODULE_NAMESPACE_SETTINGS instead

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

Deprecated. use Constants.MODULE_NAMESPACE_TRANSPORT instead

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

MODULE_NAMESPACE_INDEX - 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_LINK - 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_SPACEUSAGE - Static variable in interface com.sap.workspaces.module.extension.Constants

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

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

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

Module placeholder when the module has not been configured

MODULE_PCD_ID - Static variable in class com.sap.workspaces.module.extension.AbstractModuleViewOptions

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

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

Module placeholder in workspace template or during maintenance

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

Module placeholder when the module template has been deleted

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

Module placeholder when the module template has expired

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

Placeholder of a module template added to a workspace template; indicates that the module template has custom permissions, which can prevent certain users from accessing the module

ModuleHelper - Class in com.sap.workspaces.module

A helper class for easy 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

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

Raises an event when the specified module is updated.

movePage(IUser, IPage, int) - Method in interface com.sap.workspaces.workspace.IWorkspace

multiValueSelection() - Method in interface com.sap.workspaces.workspace.ICategory

Specifies whether multiple values of this category can be selected for a workspace

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

Deprecated. use WorkspaceInfo.navigationTargetURL

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

needApproval(IUser) - Method in class com.sap.workspaces.workspace.AbstractApprovalRequest

Checks whether the specified user needs approval for creating a shared workspace

NEW_LOCK - Static variable in class com.sap.workspaces.module.LockInfo.LockState

The module is locked by the current user for the first time

NEW_WINDOW - Static variable in class com.sap.workspaces.module.extension.ViewOption.LaunchMode

Launch target in a new window

NO_LOCK - Static variable in class com.sap.workspaces.module.LockInfo.LockState

The module is not locked

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 class com.sap.workspaces.module.extension.AbstractPrincipalLifecycle

Called when a principal is added to the workspace

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

Deprecated. Called when a principal is added to the workspace

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

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

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

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

onCreate(IModuleContext) - Method in class com.sap.workspaces.module.extension.AbstractModuleLifecycle

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

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

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

onDelete(IModuleContext) - Method in class com.sap.workspaces.module.extension.AbstractModuleLifecycle

This callback is invoked before a module instance is removed from workspace.

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

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

onExpire(IWorkspace) - Method in class com.sap.workspaces.workspace.AbstractExpiration

Implement this callback to perform actions upon workspace expiration

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

Workspace placeholder when user is not a member of the portal content admin role

onRemovePrincipal(PrincipalInfo, IModuleContext) - Method in class com.sap.workspaces.module.extension.AbstractPrincipalLifecycle

Called when a principal is removed from the workspace

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

Deprecated. Called when a principal is removed from the workspace

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

combine by OR

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

Module placeholder when the module references a deleted iView

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

P

PAGE - Static variable in class com.sap.workspaces.indexing.ItemType

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

Workspace placeholder when user tried to access a page that either has been deleted or never existed

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

The workspace is pending for approval

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

PORTAL - Static variable in class com.sap.workspaces.content.ContentProviders

ID of the portal content provider

PORTAL_COMPONENT - Static variable in class com.sap.workspaces.module.extension.ViewOption.ViewType

View is a portal component

PREFIX - Static variable in interface com.sap.workspaces.INavigationTarget

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

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

Represents a user’s role in a workspace, such as member or manager

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

quotaExceeded() - Method in interface com.sap.workspaces.workspace.IQuota

Checks if the workspace exceeds its space usage quota

R

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

Releases the lock on the specified module, if it was locked by the current user

releaseLocks(String, IUser) - Method in interface com.sap.workspaces.module.ILocking

Releases all modules locked by the specified user in the specified page

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

Removes the specified group from the role

removeOptionSettings(IModuleContext) - Method in class com.sap.workspaces.module.extension.AbstractModuleViewOptions

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

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

Removes the specified user from the role

rename(IUser, String) - Method in interface com.sap.workspaces.workspace.IPage

Renames the page

REPORT_LIST - Static variable in class com.sap.workspaces.content.Availability

Reports in Link Gallery

requestApproval(IUser, IWorkspace) - Method in class com.sap.workspaces.workspace.AbstractApprovalRequest

Requests approval of a newly created shared workspace

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

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

Module placeholder when URL module is configured with a restricted URL, and user is a workspace manager

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

Module placeholder when URL module is configured with a restricted URL, and user is a workspace member

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

Use for obtaining an instance of the IWorkspacesRuntime service

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 without callback

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

Saves the specified module settings and invokes the onChangeSettings callback of the AbstractModuleLifecycle class

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

Searches for public and restricted, but not private, workspaces according to the parameters specified by the SearchControl

SearchControl - Class in com.sap.workspaces.directory

Defines search conditions for 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 the IWorkspaceDirectory.search(com.sap.workspaces.directory.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

SEPARATOR - Static variable in interface com.sap.workspaces.INavigationTarget

this constant value is duplicated of com.sapportals.portal.navigation.INavigationConstants.URL_PREFIX_SEPARATOR.

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

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

setCategories(WorkspaceCategory[]) - Method in class com.sap.workspaces.directory.SearchFilter

Defines an array of workspace categories to include in the search

setCategories(WorkspaceCategory[]) - Method in class com.sap.workspaces.workspace.WorkspaceProperties

Assigns the specified categories to the workspace

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

Sets the error code that specifies the reason of failure

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

Defines workspaces to be excluded from the search

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

Defines the expiration date of the workspace

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

Deprecated. As of 1.1, no need to use

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 search results

setModuleID(String) - Method in class com.sap.workspaces.indexing.ItemInfo

Defines the ID of the module instance

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

setPageID(String) - Method in class com.sap.workspaces.indexing.ItemInfo

Defines the page ID

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

Defines which workspace permission policies to include in the search

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

Defines which workspace permission policies to include in the count

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

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

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

Defines the workspace quick link

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, such as AND or 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

setStatuses(Status[]) - Method in class com.sap.workspaces.directory.SearchControl

Defines which workspace statuses to include in the search, such as published, draft, closed or pending

setStatuses(Status[]) - Method in class com.sap.workspaces.directory.WorkspaceFilter

Defines which workspace statuses to include in the count, such as published, draft, closed or pending

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

setTitle(String) - Method in class com.sap.workspaces.module.extension.LinkInfo

Sets the title of the link

setTypes(Type[]) - Method in class com.sap.workspaces.directory.SearchControl

Defines which workspace types to include in the search, such as shared or personal

setTypes(Type[]) - Method in class com.sap.workspaces.directory.WorkspaceFilter

Defines which workspace types to include in the count, such as shared or personal

setURL(String) - Method in class com.sap.workspaces.module.extension.LinkInfo

Sets the URL of the link

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

Defines the value of the property

setValueIDs(String[]) - Method in class com.sap.workspaces.workspace.WorkspaceCategory

Assigns category values to the workspace

setWorkspaceIdentifier(IIdentifier) - Method in class com.sap.workspaces.indexing.ItemInfo

Defines the identifier of the workspace

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

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

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

TARGET_KEY - Static variable in class com.sap.workspaces.module.extension.ViewOption.ViewType

View is a target key

TargetKey - Class in com.sap.workspaces

Enumeration of navigation targets of all enterprise workspaces screens

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

TEXTPAD - Static variable in class com.sap.workspaces.indexing.ItemType

thresholdExceeded() - Method in interface com.sap.workspaces.workspace.IQuota

Checks if the workspace exceeds its quota threshold

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

toString() - Method in class com.sap.workspaces.content.Availability

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.indexing.ItemInfo

toString() - Method in class com.sap.workspaces.indexing.ItemType

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

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

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

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.WorkspaceCategory

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

URL_SEPARATOR - Static variable in class com.sap.workspaces.indexing.ItemInfoHelper

V

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

valueIDs - Variable in class com.sap.workspaces.workspace.WorkspaceCategory

valueOf(String) - Static method in class com.sap.workspaces.content.Availability

Converts the specified string value to the value

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

valueOf(String) - Static method in class com.sap.workspaces.module.extension.ViewOption.LaunchMode

Converts the specified string value to the LaunchMode

valueOf(String) - Static method in class com.sap.workspaces.module.extension.ViewOption.ViewType

Converts the specified string value to the ViewType

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

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

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

Represents a module view option in the module tray menu

ViewOption(String, ViewOption.LaunchMode, ViewOption.ViewInfo, int) - Constructor for class com.sap.workspaces.module.extension.ViewOption

Use this constructor to launch the view either in place, or in a new window of the default size (600 x 400 pixels)

ViewOption(String, ViewOption.LaunchMode, ViewOption.ViewInfo, int, int, int) - Constructor for class com.sap.workspaces.module.extension.ViewOption

Use this constructor to launch the view in a new window of the specific size (in pixels)

ViewOption.LaunchMode - Class in com.sap.workspaces.module.extension

Contains constants that define how to launch the target of a tray option

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

Constructs a new LaunchMode

ViewOption.ViewInfo - Class in com.sap.workspaces.module.extension

Represents a module view

ViewOption.ViewInfo(TargetKey) - Constructor for class com.sap.workspaces.module.extension.ViewOption.ViewInfo

ViewOption.ViewInfo(String, ViewOption.ViewType) - Constructor for class com.sap.workspaces.module.extension.ViewOption.ViewInfo

ViewOption.ViewType - Class in com.sap.workspaces.module.extension

Defines the type of the module view

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

Constructs a new ViewType

W

WORKSPACE - Static variable in class com.sap.workspaces.content.ContentProviders

ID of the workspace content (module templates) provider

WORKSPACE - Static variable in class com.sap.workspaces.indexing.ItemType

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

Workspace placeholder when user tried to access a workspace that has not been approved yet

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

Workspace placeholder when user tried to access a closed workspace

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

Workspace directory

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

Workspace placeholder when user tried to access a workspace that either has been deleted, never existed or is private

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

Workspace explorer

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_MAINTENANCE_MODE - Static variable in class com.sap.workspaces.TargetKey

Workspace placeholder when user tried to access a workspace in maintenance mode

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

Workspace placeholder when user tried to access a restricted workspace

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

Workspace settings

workspaceCategories - Variable in class com.sap.workspaces.workspace.TemplateInfo

WorkspaceCategory - Class in com.sap.workspaces.workspace

Represents a workspace category assigned to a workspace

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

Constructor

WorkspaceFilter - Class in com.sap.workspaces.directory

Defines filters for counting the number of workspaces

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

WorkspaceInfo - Class in com.sap.workspaces.directory

A read-only data object through which you can access workspace properties

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

WorkspaceProperties - Class in com.sap.workspaces.workspace

A data object used to access 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

Base exception of enterprise workspaces

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

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

WPC - Static variable in class com.sap.workspaces.content.ContentProviders

ID of the WPC content provider

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

Placeholder indicating that the portal is in write-protect mode

writeEntryData(OutputStream) - Method in class com.sap.workspaces.module.extension.AbstractExportEntry

Writes all entries to the output stream

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

Deprecated. Saves entries to the output stream

WRITEPROTECT_MODE_EXCEPTION - Static variable in interface com.sap.workspaces.authoring.IWriteProtectMode

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