|
Oracle® Collaboration Suite Workspaces API Reference 10g (10.1.1.0.2) Part No. B16233-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Encapsulating the properties of a workspace: name, description, configuration options, etc. It does not capture the properties of its resources
, nor its child workspaces.
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 |
public static final java.lang.String CONTACT_EMAIL_ADDRESS
public static final java.lang.String CONTACT_PERSON
public static final java.lang.String ID_NO_PARENT
public static final java.lang.String MEMBER_DEFAULT_ROLE
public static final java.lang.String OWNER
public static final java.lang.String PUBLICLY_LISTED
public static final java.lang.String READ_ONLY
public static final CwUid UID_NO_PARENT
public static final java.lang.String WELCOME_MESSAGE
public static final java.lang.String WORKSPACE_PATH_SEPARATOR
public static final java.lang.String WORKSPACE_TEMPLATE_NAME
Method Detail |
public CwMemberRoleType getDefaultMemberRoleType()
public java.lang.String getMembershipNotificationOption()
public java.lang.String getPath()
Pricing
under the workspace RFP1
, the path will be /RFP1/Pricing
public java.lang.String getWelcomeMessage()
public java.lang.String getWorkspaceTemplateName()
public void setContactEmailAddress(java.lang.String contactEmailAddress) throws CwException
contactEmailAddress
- The email address for sending email regarding any issue related to this workspace.CwException
- if an invalid email address is passedpublic void setContactPerson(CwUser contactPerson) throws CwException
contactPerson
- A user object for the workspace contact personCwException
- if the specified contact person is not an administrator of this workspacepublic void setDefaultMemberRoleType(CwMemberRoleType defaultRole) throws CwException
CwException
public void setDescription(java.lang.String description) throws CwException
description
- the description of the workspaceCwException
public void setDisplayName(java.lang.String displayName) throws CwException
displayName
- the display name of the workspaceCwException
public void setMemberAccessSetting(java.lang.String accessSetting) throws CwException
accessSetting
- ENABLED or DISABLEDCwException
- if an invalid access setting is passedpublic void setMembershipNotificationOption(java.lang.String option) throws CwException
option
- ALL_MEMBERS, USER or NONE.CwException
public void setOwner(CwUser user) throws CwException
user
- the owner of the workspace.CwException
public void setPubliclyListed(boolean publiclyListed) throws CwException
publiclyListed
- Whether the workspace will be listed for non-members or notCwException
public void setReadOnly(boolean readOnly) throws CwException
readOnly
- true => workspace is read-only, false => workspace is read-write.CwException
public void setWelcomeMessage(java.lang.String welcomeMessage) throws CwException
welcomeMessage
- Instructions for where to start, tips for finding information etc.CwException
public void unsetPubliclyListed() throws CwException
CwException
public void unsetReadOnly() throws CwException
CwException
public java.lang.String getContactEmailAddress()
public CwUser getContactPerson()
public java.util.Date getCreatedTime()
public java.lang.String getDescription()
public java.lang.String getDisplayName()
"/"
public CwUser getLastModifiedBy() throws CwException
CwException
public java.util.Date getLastModifiedTime() throws CwException
CwException
public java.lang.String getMemberAccessSetting()
public java.lang.String getName()
"/"
public CwUser getOwner()
public CwUid getParentUid()
UID_NO_PARENT
if the workspace is a top-level workspace that has no parent.public CwUid getUid()
public boolean isPubliclyListed()
public boolean isReadOnly()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |