com.sap.workspaces.workspace

Interface IWorkspace

public interface IWorkspace

Provides access to the workspace information and member list

Method Summary

Date	getCreatedAt() Returns the workspace creation date
String	getDescription() Returns the workspace description
IIdentifier	getIdentifier() Returns the workspace identifier
IMemberList	getMemberList() Returns the member list of this workspace
String	getName() Returns the workspace name
String	getNavigationTarget() Returns the workspace navigation target URL, which can be passed to the EPCM.doNavigate(navigationTarget) method
IPage	getPage(String ID) Returns a workspace page with the specified ID
IPage[]	getPages() Returns an array of the workspace pages
PermissionPolicy	getPermissionPolicy() Returns the workspace permission policy
Status	getStatus() Returns the workspace status, such as PUBLISHED, DRAFT or CLOSED
void	setStatus(com.sap.security.api.IUser user, Status newStatus, String reason) Defines the workspace status
void	update(WorkspaceProperties workspaceProperties, com.sap.security.api.IUser user) Updates the workspace properties

Method Detail

getMemberList

IMemberList getMemberList()

Returns the member list of this workspace

Returns:

the member list of this workspace

getPages

IPage[] getPages()
                 throws WorkspacesRuntimeException

Returns an array of the workspace pages

Returns:

an array of the workspace pages

Throws:

WorkspacesRuntimeException

getPage

IPage getPage(String ID)
              throws WorkspacesRuntimeException

Returns a workspace page with the specified ID

Parameters:

ID - the page ID

Returns:

workspace page

Throws:

WorkspacesRuntimeException

setStatus

void setStatus(com.sap.security.api.IUser user,
               Status newStatus,
               String reason)
               throws WorkspacesRuntimeException

Defines the workspace status

Parameters:

user - the user that has permissions to change the status

newStatus - the new status, such as PUBLISHED, DRAFT or CLOSED

reason - the free text describing the reason for changing the workspace status (optional)

Throws:

WorkspacesRuntimeException

update

void update(WorkspaceProperties workspaceProperties,
            com.sap.security.api.IUser user)
            throws WorkspacesRuntimeException

Updates the workspace properties

Parameters:

workspaceProperties - the workspace properties

user - the user that has permissions to update the properties

Throws:

WorkspacesRuntimeException

getIdentifier

IIdentifier getIdentifier()

Returns the workspace identifier

Returns:

the workspace identifier

getName

String getName()

Returns the workspace name

Returns:

the workspace name

getDescription

String getDescription()

Returns the workspace description

Returns:

the workspace description

getCreatedAt

Date getCreatedAt()

Returns the workspace creation date

Returns:

the workspace creation date

getPermissionPolicy

PermissionPolicy getPermissionPolicy()

Returns the workspace permission policy

Returns:

the workspace permission policy

getStatus

Status getStatus()

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

Returns:

the workspace status

getNavigationTarget

String getNavigationTarget()

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

Returns:

the workspace navigation target