oracle.workspaces.container
Interface CwWorkspaceSummary

public interface CwWorkspaceSummary

Representing a summary of a workspace. It is typically used in listing workspaces, e.g., listing all the workspaces the user is a memeber of.

Method Summary

java.lang.String	getContactEmailAddress()
CwUser	getContactPerson()
java.util.Date	getCreatedTime() Read-only property of the modification time of the workspace.
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()
CwMemberRoleType	getMyMemberRoleType()
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()
CwUid	getUid() A server-generated unique identifier of the workspace across all workspaces.
boolean	isPubliclyListed()
boolean	isReadOnly()

Method Detail

getMyMemberRoleType

public CwMemberRoleType getMyMemberRoleType()

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 CwWorkspaceProperties.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.