com.sap.workspaces.workspace

Interface IWorkspace

public interface IWorkspace

Provides access to the workspace information and member list

Method Summary

IPage	createPage(com.sap.security.api.IUser user, String pageName) Creates a workspace page
boolean	deletePage(com.sap.security.api.IUser user, String pageID) Deletes a workspace page
com.sap.security.api.IUser	getApprovedBy() Returns the user who has approved this workspace; relevant only if the customer has implemented workspace approval flow
WorkspaceCategory[]	getCategories() Returns the categories assigned to the workspace
Date	getCreatedAt() Returns the workspace creation date
String	getDescription() Returns the workspace description
Date	getExpirationDate() Returns the expiration date of the workspace
IIdentifier	getIdentifier() Returns the workspace identifier
Locale	getLocale() Returns the master locale of the workspace
IMemberList	getMemberList() Returns the member list of the workspace
String	getName() Returns the workspace name
String	getNavigationTarget() Deprecated. use getNavigationTargetURL()
INavigationTarget	getNavigationTargetURL() 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
String	getQuicklink() Returns the quick link to the workspace
IQuota	getQuota() Returns the space usage quota of the workspace
Status	getStatus() Returns the workspace status
boolean	movePage(com.sap.security.api.IUser user, IPage page, int newPosition)
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 the workspace

Returns:

The member list of the 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:

The workspace page

Throws:

WorkspacesRuntimeException

createPage

IPage createPage(com.sap.security.api.IUser user,
                 String pageName)
                 throws WorkspacesRuntimeException

Creates a workspace page

Parameters:

user - the user who creates the page

pageName - the page name

Returns:

The newly created page

Throws:

WorkspacesRuntimeException

deletePage

boolean deletePage(com.sap.security.api.IUser user,
                   String pageID)
                   throws WorkspacesRuntimeException

Deletes a workspace page

Parameters:

user - the user who deletes the page

pageID - the ID of the page to delete

Returns:

True if the page was deleted successfully

Throws:

WorkspacesRuntimeException

movePage

boolean movePage(com.sap.security.api.IUser user,
                 IPage page,
                 int newPosition)
                 throws WorkspacesRuntimeException

Parameters:

user - the user who moves the page

page - the page to move

newPosition - the new position of the 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

getQuicklink

String getQuicklink()

Returns the quick link to the workspace

Returns:

The quick link to the workspace

getExpirationDate

Date getExpirationDate()

Returns the expiration date of the workspace

Returns:

The expiration date of the workspace

Since:

1.1 SP02

getLocale

Locale getLocale()

Returns the master locale of the workspace

Returns:

The master locale of the workspace

Since:

1.1 SP02

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

Returns:

The workspace status, such as published, draft or closed

getNavigationTarget

String getNavigationTarget()

Deprecated. use getNavigationTargetURL()

getNavigationTargetURL

INavigationTarget getNavigationTargetURL()

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

Returns:

The workspace navigation target URL

getApprovedBy

com.sap.security.api.IUser getApprovedBy()

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

Returns:

The user who has approved this workspace

getCategories

WorkspaceCategory[] getCategories()

Returns the categories assigned to the workspace

Returns:

An array of the categories assigned to the workspace

getQuota

IQuota getQuota()

Returns the space usage quota of the workspace

Returns:

The space usage quota in MB