java.lang.Object | +--com.ibm.commerce.collaboration.manager.CollabManager
This class is the singleton that controls the operations of Collaborative Workspaces
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT Copyright statement |
static java.lang.String |
ROLE_AUTHOR Constant for author role |
static java.lang.String |
ROLE_MANAGER Constant for manager role |
static java.lang.String |
ROLE_READER Constant for reader role |
Method Summary | |
---|---|
static int |
addCWMember(java.lang.String collabWorkspaceId,
java.lang.String memberDN, java.lang.String role) Adds a member to the collaborative workspace |
static int |
addCWMembers(
CollabWorkspaceInfo csbean) Adds members to the collaborative workspace |
static int |
addCWMembers(java.lang.String collabWorkspaceId,
java.util.Vector memberDNs, java.lang.String role) Adds members to the collaborative workspace |
static boolean |
changeCWDescription(java.lang.String collabSpaceID,
java.lang.String description) Modifies the collaborative workspace description |
static java.lang.String |
createCollabWorkspace(
CollabWorkspaceInfo cspaceBean) Creates a collaboration space. |
static
CollabWorkspaceInfo |
getCollabWorkspaceDetails(java.lang.String collabSpaceID) Gets the details of a collaborative workspace |
static java.lang.String |
getCollabWorkspaceURL(java.lang.String cwId) Gets the collaborative workspace URL given the workspace ID |
static java.lang.String |
getCWMemberRole(java.lang.String memberDN,
java.lang.String cwId) Returns the role of a member within a collaborative workspace |
static java.util.Vector |
listCollabWorkspaces() Lists all the collaborative workspaces that exist in the collaborative application server |
static java.util.Vector |
listCollabWorkspaces(java.lang.String userDN) This function returns a list of CollabSpaceBean objects for the given LDAP uid. |
static java.util.Vector |
listCWMembers(java.lang.String collabSpaceID) Lists the group members distinguished name (DN) for the given collaborative workspace ID |
static java.util.Vector |
listCWMembers(java.lang.String collabSpaceID,
java.lang.String role) This lists the group members distinguished name (DN) for the given collaborative workspace ID and group ("Manager", "Author", "Reader" and null for all) |
static java.util.Vector |
listCWTemplates() Lists all available collaborative workspace templates |
static boolean |
removeCollabWorkpace(java.lang.String collabSpaceID) Deletes a given collaborative workspace from the QuickPlace server |
static int |
removeCWMember(java.lang.String cwId,
java.lang.String memberDN) Removes a member from a collaborative workspace |
static int |
removeCWMembers(
CollabWorkspaceInfo csbean) Remove members from the collaborative workspace |
static int |
removeCWMembers(java.lang.String cwId,
java.util.Vector memberDNs) Remove members from the collaborative workspace |
static void |
setCWMemberRole(java.lang.String memberDN, java.lang.String cwId,
java.lang.String role) Set the role of a member within a collaborative workspace |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String ROLE_MANAGER
public static final java.lang.String ROLE_AUTHOR
public static final java.lang.String ROLE_READER
Method Detail |
---|
public static int addCWMembers(CollabWorkspaceInfo csbean) throws ECException
csbean
- Collaborative workspaces informationjava.lang.Exception
- thrown by WebSphereCommerceECException
public static int addCWMembers(java.lang.String collabWorkspaceId, java.util.Vector memberDNs, java.lang.String role) throws ECException
collabWorkspaceId
- The collaborative workspace IDrole
- Role of the members to be added, can be
CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or
CollabManager.ROLE_READERjava.lang.Exception
- thrown by WebSphereCommerceECException
public static int addCWMember(java.lang.String collabWorkspaceId, java.lang.String memberDN, java.lang.String role) throws ECException
collabWorkspaceId
- The collaborative workspace IDrole
- Role of the members to be added, can be
CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or
CollabManager.ROLE_READERjava.lang.Exception
- thrown by WebSphereCommerceECException
public static boolean changeCWDescription(java.lang.String collabSpaceID, java.lang.String description) throws ECException
collabSpaceID
- collaborative workspace IDdescription
- the new descriptionjava.lang.Exception
- thrown by WebSphereCommerceECException
public static java.lang.String createCollabWorkspace(CollabWorkspaceInfo cspaceBean) throws ECException
cspaceBean
- Collaborative workspace informationjava.lang.Exception
- thrown by WebSphereCommerceECException
public static java.lang.String getCollabWorkspaceURL(java.lang.String cwId) throws ECException
cwId
- The collaborative workspace IDjava.lang.Exception
- thrown by WebSphereCommerceECException
public static CollabWorkspaceInfo getCollabWorkspaceDetails(java.lang.String collabSpaceID) throws ECException
collabSpaceID
- collaborative workspace IDjava.lang.Exception
- thrown by WebSphereCommerceECException
public static java.lang.String getCWMemberRole(java.lang.String memberDN, java.lang.String cwId) throws ECException
memberDN
- The distinguished name (DN) of the membercwId
- collaborative workspace IDjava.lang.Exception
- thrown by WebSphereCommerceECException
public static void setCWMemberRole(java.lang.String memberDN, java.lang.String cwId, java.lang.String role) throws ECException
memberDN
- The distinguished name (DN) of the membercwId
- collaborative workspace IDrole
- The new role of the member, can be
CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or
CollabManager.ROLE_READERjava.lang.Exception
- thrown by WebSphereCommerceECException
public static java.util.Vector listCollabWorkspaces() throws ECException
java.lang.Exception
- thrown by WebSphereCommerceECException
public static java.util.Vector listCollabWorkspaces(java.lang.String userDN) throws ECException
userDN
- distinguished name (DN) of the memberExceptions
- thrown by WebSphereCommerce serverECException
public static java.util.Vector listCWTemplates() throws ECException
java.lang.Exception
- thrown by WebSphereCommerceECException
public static java.util.Vector listCWMembers(java.lang.String collabSpaceID) throws ECException
java.lang.Exception
- thrown by WebSphereCommerceECException
public static java.util.Vector listCWMembers(java.lang.String collabSpaceID, java.lang.String role) throws ECException
java.lang.Exception
- thrown by WebSphereCommerceECException
public static boolean removeCollabWorkpace(java.lang.String collabSpaceID) throws ECException
collabSpaceID
- collaborative workspace IDjava.lang.Exception
- thrown by WebSphereCommerceECException
public static int removeCWMembers(CollabWorkspaceInfo csbean) throws ECException
csbean
- Collaborative workspaces informationjava.lang.Exception
- thrown by WebSphereCommerceECException
public static int removeCWMembers(java.lang.String cwId, java.util.Vector memberDNs) throws ECException
cwId
- The collaborative workspaces IDmemberDNs
- A Vector of memberDNs to be addedjava.lang.Exception
- thrown by WebSphereCommerceECException
public static int removeCWMember(java.lang.String cwId, java.lang.String memberDN) throws ECException
cwId
- The collaborative workspace IDmemberDN
- The distinguished name (DN) of the member to be
removedjava.lang.Exception
- thrown by WebSphereCommerceECException