com.sap.workspaces.workspace

Interface IPage

public interface IPage

Provides information about a workspace page

Method Summary

void	addModule(com.sap.security.api.IUser user, String contentProviderID, String contentID) Adds a workspace module or an external content item as a module to the page
String	getID() Returns the page ID
IModuleID[]	getModuleIdentifiers() Returns an array of module IDs of all modules in the page
String[]	getModuleIDs() Deprecated. use getModuleIdentifiers() instead. Returns an array of IDs of all modules in the page
String	getName() Returns the page name
INavigationTarget	getNavigationTarget() Returns the page navigation target
boolean	rename(com.sap.security.api.IUser user, String newName) Renames the page

Method Detail

getID

String getID()

Returns the page ID

Returns:

The page ID

getName

String getName()

Returns the page name

Returns:

The page name

rename

boolean rename(com.sap.security.api.IUser user,
               String newName)
               throws WorkspacesRuntimeException

Renames the page

Parameters:

user - the current user

newName - the page's new name

Returns:

True if renaming was successful

Throws:

WorkspacesRuntimeException

getNavigationTarget

INavigationTarget getNavigationTarget()

Returns the page navigation target

Returns:

The navigation target of the page

getModuleIDs

String[] getModuleIDs()
                      throws WorkspacesRuntimeException

Deprecated. use getModuleIdentifiers() instead. Returns an array of IDs of all modules in the page

Returns:

An array of IDs of all modules in the page

Throws:

WorkspacesRuntimeException

getModuleIdentifiers

IModuleID[] getModuleIdentifiers()
                                 throws WorkspacesRuntimeException

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

Returns:

An array of module IDs of all modules in the page

Throws:

WorkspacesRuntimeException

addModule

void addModule(com.sap.security.api.IUser user,
               String contentProviderID,
               String contentID)
               throws WorkspacesRuntimeException

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

Parameters:

user - the current user

contentProviderID - the ID of either a custom or SAP content provider

contentID - the ID of the module or content item

Throws:

WorkspacesRuntimeException