oracle.workspaces.container
Class CwWorkspaceDefinition

java.lang.Object
oracle.workspaces.container.CwWorkspaceDefinition

public class CwWorkspaceDefinition

extends java.lang.Object

An instance of this class contains all the information needed to created a workspace or subworkspace. Pass an instance of this class to CwSession.createWorkspace(oracle.workspaces.container.CwWorkspaceDefinition).

Constructor Summary

CwWorkspaceDefinition()

Method Summary

boolean	allowPartialSuccess()
java.lang.String	getContactEmailAddress()
CwUser	getContactPerson()
CwMemberRoleType	getDefaultMemberRoleType()
java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.lang.String	getMemberAccessSetting()
CwMemberable[]	getMembers() Returns the membership information for the members to be added to the workspace to be created.
java.lang.String	getMembershipNotificationOption() Returns who all are notified when a user is added to or removed from a workspace.
java.lang.String	getName() A human readable name of the workspace.
CwUid	getParentUid()
java.lang.String	getPath() The absolute path to the workspace, reflecting the hierarchy of the workspaces.
CwResourceDefinition[]	getResourceDefinitions()
CwWorkspaceTemplate	getTemplate() Returns the workspace template (if any) to be used for the workspace to be created
java.lang.String	getWelcomeMessage()
boolean	isPubliclyListed()
void	setAllowPartialSuccess(boolean setting) By default allowPartialSuccess is true
void	setAuditedActions(java.lang.String auditedActions)
void	setContactEmailAddress(java.lang.String contactEmailAddress)
void	setContactPerson(CwUser contactPerson)
void	setDefaultMemberRoleType(CwMemberRoleType defaultRole)
void	setDescription(java.lang.String description)
void	setDisplayName(java.lang.String displayName)
void	setMemberAccessSetting(java.lang.String accessSetting)
void	setMembers(CwMemberable[] members) Sets the membership information for the members to be added to the workspace to be created.
void	setMembershipNotificationOption(java.lang.String option)
void	setName(java.lang.String name)
void	setParentUid(CwUid uid) sets the UID of the parent workspace
void	setPath(java.lang.String pathName)
void	setPubliclyListed(boolean publiclyListed)
void	setResourceDefinitions(CwResourceDefinition[] resDefs)
void	setTemplate(CwWorkspaceTemplate wsTemplate) Sets the workspace template to be used for workspace creation
void	setWelcomeMessage(java.lang.String welcomeMessage)
void	unsetPubliclyListed() uninitializes the publicly listed setting so that value in the template is used

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CwWorkspaceDefinition

public CwWorkspaceDefinition()

Method Detail

allowPartialSuccess

public boolean allowPartialSuccess()

Returns:

true means workspace will be created even if some ignorable errors like an offline resource are encountered

getMembers

public CwMemberable[] getMembers()

Returns the membership information for the members to be added to the workspace to be created. This does not include the workspace creator.

Returns:

the membership information or null if no members have been set (using setMembers)

getResourceDefinitions

public CwResourceDefinition[] getResourceDefinitions()

getTemplate

public CwWorkspaceTemplate getTemplate()

Returns the workspace template (if any) to be used for the workspace to be created

Returns:

the workspace template or null if no template has been set (using setTemplate)

setAllowPartialSuccess

public void setAllowPartialSuccess(boolean setting)

By default allowPartialSuccess is true

setMembers

public void setMembers(CwMemberable[] members)

Sets the membership information for the members to be added to the workspace to be created.

Parameters:

members - list containing membership information or null. This should not include workspace creator.

setName

public void setName(java.lang.String name)
             throws CwException

Parameters:

name - the name of the workspace

Throws:

CwException

setParentUid

public void setParentUid(CwUid uid)
                  throws CwException

sets the UID of the parent workspace

Parameters:

uid - the UID of the parent workspace

Throws:

CwException

setPath

public void setPath(java.lang.String pathName)
             throws CwException

Throws:

CwException

setResourceDefinitions

public void setResourceDefinitions(CwResourceDefinition[] resDefs)

setTemplate

public void setTemplate(CwWorkspaceTemplate wsTemplate)

Sets the workspace template to be used for workspace creation

Parameters:

wsTemplate - a reference to the workspace template object or null

getContactEmailAddress

public java.lang.String getContactEmailAddress()

Returns:

Email address for sending email regarding any issue related to this workspace, e.g., membership request.

getContactPerson

public CwUser getContactPerson()

Returns:

The contact person for the workspace. A user needs to contact this person for any issue related to this workspace, e.g., membership request.

getDefaultMemberRoleType

public CwMemberRoleType getDefaultMemberRoleType()

Returns:

the name of the default role of a member. It must be non-null. The default role will be applied to members who have no explicit role assigned.

getDescription

public java.lang.String getDescription()

Returns:

the description of the workspace

getDisplayName

public java.lang.String getDisplayName()

Returns:

the display name of the workspace

getMemberAccessSetting

public java.lang.String getMemberAccessSetting()

Returns:

ENABLED or DISABLED. If DISABLED, workspace adminsitrators can access the workspace and other members can only query workspace properties.

getMembershipNotificationOption

public java.lang.String getMembershipNotificationOption()

Returns who all are notified when a user is added to or removed from a workspace. TBD: are users who are members through a group notified?

Returns:

ALL_MEMBERS, USER or NONE.

getName

public java.lang.String getName()

A human readable name of the workspace. It also serves as an unique identifier of the workspace within the scope of

• top-level workspaces: across all top-level workspaces
• non top-level workspaces: across all sub workspaces of its parent workspaces.

Additional restriction on name:

• It cannot contain the character backslah "/"
• length: a maximum of 64 characters

Returns:

the name of the workspace

getParentUid

public CwUid getParentUid()

Returns:

the ID of the parent workspace, or #ID_NO_PARENT if the workspace is a top-level workspace that has no parent.

getPath

public java.lang.String getPath()

The absolute path to the workspace, reflecting the hierarchy of the workspaces. The path is based on the names (and not display names) of the workspace and its ancestors. For example, for workspace named Pricing under the workspace RFP1, the path will be /RFP1/Pricing

Returns:

the absolute path of the workspace

getWelcomeMessage

public java.lang.String getWelcomeMessage()

Returns:

Instructions for where to start, tips for finding information etc.

isPubliclyListed

public boolean isPubliclyListed()

Returns:

true if the workspace can be listed by non-members

setAuditedActions

public void setAuditedActions(java.lang.String auditedActions)
                       throws CwException

Parameters:

auditedActions - ALL to enable auditing for the workspace.

Throws:

CwException

setContactEmailAddress

public void setContactEmailAddress(java.lang.String contactEmailAddress)
                            throws CwException

Parameters:

contactEmailAddress - The email address for sending email regarding any issue related to this workspace.

Throws:

CwException - if an invalid email address is passed

setContactPerson

public void setContactPerson(CwUser contactPerson)
                      throws CwException

Parameters:

contactPerson - A user object for the workspace contact person

Throws:

CwException - if the specified contact person is not an administrator of this workspace

setDefaultMemberRoleType

public void setDefaultMemberRoleType(CwMemberRoleType defaultRole)
                              throws CwException

Throws:

CwException

setDescription

public void setDescription(java.lang.String description)
                    throws CwException

Parameters:

description - the description of the workspace

Throws:

CwException

setDisplayName

public void setDisplayName(java.lang.String displayName)
                    throws CwException

Parameters:

displayName - the displayName of the workspace

Throws:

CwException

setMemberAccessSetting

public void setMemberAccessSetting(java.lang.String accessSetting)
                            throws CwException

Parameters:

accessSetting - ENABLED or DISABLED

Throws:

CwException - if an invalid access setting is passed

setMembershipNotificationOption

public void setMembershipNotificationOption(java.lang.String option)
                                     throws CwException

Parameters:

option - ALL_MEMBERS, USER or NONE. is added to a workspace

Throws:

CwException

setPubliclyListed

public void setPubliclyListed(boolean publiclyListed)
                       throws CwException

Parameters:

publiclyListed - Whether the workspace will be listed for non-members or not

Throws:

CwException

setWelcomeMessage

public void setWelcomeMessage(java.lang.String welcomeMessage)
                       throws CwException

Parameters:

welcomeMessage - Instructions for where to start, tips for finding information etc.

Throws:

CwException

unsetPubliclyListed

public void unsetPubliclyListed()
                         throws CwException

uninitializes the publicly listed setting so that value in the template is used

Throws:

CwException