oracle.workspaces.container
Interface CwWorkspaceProperties

public interface CwWorkspaceProperties

Encapsulating the properties of a workspace: name, description, configuration options, etc. It does not capture the properties of its resources, nor its child workspaces.

See Also:

CwWorkspace

Nested Class Summary

static class	CwWorkspaceProperties.DESCRIPTION
static class	CwWorkspaceProperties.DISPLAY_NAME
static class	CwWorkspaceProperties.MEMBER_ACCESS
static class	CwWorkspaceProperties.MEMBERSHIP_NOTIFICATION
static class	CwWorkspaceProperties.PATH
static class	CwWorkspaceProperties.WORKSPACE_NAME

Field Summary

static java.lang.String	CONTACT_EMAIL_ADDRESS
static java.lang.String	CONTACT_PERSON
static java.lang.String	ID_NO_PARENT The parent workspace ID of a top-level workspace that has no parent.
static java.lang.String	MEMBER_DEFAULT_ROLE
static java.lang.String	OWNER
static java.lang.String	PUBLICLY_LISTED
static java.lang.String	READ_ONLY
static CwUid	UID_NO_PARENT The parent workspace UID of a top-level workspace that has no parent.
static java.lang.String	WELCOME_MESSAGE
static java.lang.String	WORKSPACE_PATH_SEPARATOR
static java.lang.String	WORKSPACE_TEMPLATE_NAME

Method Summary

java.lang.String	getContactEmailAddress()
CwUser	getContactPerson()
java.util.Date	getCreatedTime() Read-only property of the modification time of the workspace.
CwMemberRoleType	getDefaultMemberRoleType()
java.lang.String	getDescription()
java.lang.String	getDisplayName() A human readable name of the workspace that can be used for display purposes, e.g., list of my workspaces.
CwUser	getLastModifiedBy()
java.util.Date	getLastModifiedTime()
java.lang.String	getMemberAccessSetting()
java.lang.String	getMembershipNotificationOption() Returns who all are notified when a user is added (removed) to (from) a workspace or when the role of a member is changed.
java.lang.String	getName() The name of a workspace cannot be changed after the workspace is created.
CwUser	getOwner() The owner of the workspace.
CwUid	getParentUid()
java.lang.String	getPath() The absolute path to the workspace, reflecting the hierarchy of the workspaces.
CwUid	getUid() A server-generated unique identifier of the workspace across all workspaces.
java.lang.String	getWelcomeMessage()
java.lang.String	getWorkspaceTemplateName()
boolean	isPubliclyListed()
boolean	isReadOnly()
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	setMembershipNotificationOption(java.lang.String option)
void	setOwner(CwUser user)
void	setPubliclyListed(boolean publiclyListed)
void	setReadOnly(boolean readOnly)
void	setWelcomeMessage(java.lang.String welcomeMessage)
void	unsetPubliclyListed() uninitializes the publicly listed setting so that value in the template is used
void	unsetReadOnly() uninitializes read only setting so that the value in the template is used

Field Detail

CONTACT_EMAIL_ADDRESS

public static final java.lang.String CONTACT_EMAIL_ADDRESS

See Also:

Constant Field Values

CONTACT_PERSON

public static final java.lang.String CONTACT_PERSON

See Also:

Constant Field Values

ID_NO_PARENT

public static final java.lang.String ID_NO_PARENT

The parent workspace ID of a top-level workspace that has no parent.

See Also:

Constant Field Values

MEMBER_DEFAULT_ROLE

public static final java.lang.String MEMBER_DEFAULT_ROLE

See Also:

Constant Field Values

OWNER

public static final java.lang.String OWNER

See Also:

Constant Field Values

PUBLICLY_LISTED

public static final java.lang.String PUBLICLY_LISTED

See Also:

Constant Field Values

READ_ONLY

public static final java.lang.String READ_ONLY

See Also:

Constant Field Values

UID_NO_PARENT

public static final CwUid UID_NO_PARENT

The parent workspace UID of a top-level workspace that has no parent.

WELCOME_MESSAGE

public static final java.lang.String WELCOME_MESSAGE

See Also:

Constant Field Values

WORKSPACE_PATH_SEPARATOR

public static final java.lang.String WORKSPACE_PATH_SEPARATOR

See Also:

Constant Field Values

WORKSPACE_TEMPLATE_NAME

public static final java.lang.String WORKSPACE_TEMPLATE_NAME

See Also:

Constant Field Values

Method Detail

getDefaultMemberRoleType

public CwMemberRoleType getDefaultMemberRoleType()

Returns:

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.

getMembershipNotificationOption

public java.lang.String getMembershipNotificationOption()

Returns who all are notified when a user is added (removed) to (from) a workspace or when the role of a member is changed.

Returns:

ALL_MEMBERS, USER or NONE.

getPath

public java.lang.String getPath()

The absolute path to the workspace, reflecting the hierarchy of the workspaces. 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.

getWorkspaceTemplateName

public java.lang.String getWorkspaceTemplateName()

Returns:

The name of the template used for creating this workspace

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 display name 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.

Throws:

CwException

setOwner

public void setOwner(CwUser user)
              throws CwException

Parameters:

user - the owner of the 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

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws CwException

Parameters:

readOnly - true => workspace is read-only, false => workspace is read-write.

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

unsetReadOnly

public void unsetReadOnly()
                   throws CwException

uninitializes read only setting so that the value in the template is used

Throws:

CwException

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.

getCreatedTime

public java.util.Date getCreatedTime()

Read-only property of the modification time of the workspace. Modification incudes properties of the workspace, and does not include any modification in the resources and the subworkspaces.

Returns:

the creation time of the workspace.

getDescription

public java.lang.String getDescription()

Returns:

the description of the workspace

getDisplayName

public java.lang.String getDisplayName()

A human readable name of the workspace that can be used for display purposes, e.g., list of my workspaces. It can be changed by a workspace administrator. 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.

It is case-sensitive. Additional restriction on display name:

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

Returns:

the display name of the workspace

getLastModifiedBy

public CwUser getLastModifiedBy()
                         throws CwException

Returns:

the user who last modified this workspace

Throws:

CwException

getLastModifiedTime

public java.util.Date getLastModifiedTime()
                                   throws CwException

Returns:

the last modification time of the workspace.

Throws:

CwException

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.

getName

public java.lang.String getName()

The name of a workspace cannot be changed after the workspace is created. 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 workspace.

The functional units for the workspace are named in resource repositories using this workspace name. Additional restriction on name:

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

Returns:

the name of the workspace

getOwner

public CwUser getOwner()

The owner of the workspace.

Returns:

the owner of the workspace.

getParentUid

public CwUid getParentUid()

Returns:

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

getUid

public CwUid getUid()

A server-generated unique identifier of the workspace across all workspaces.

Returns:

the unique ID of the workspace

isPubliclyListed

public boolean isPubliclyListed()

Returns:

true if the workspace can be listed by non-members

isReadOnly

public boolean isReadOnly()

Returns:

true if the workspace is read-only, false otherwise.