com.ibm.commerce.collaboration.collabapplication
Interface CollabAppAdapter
- All Known Implementing Classes:
- QPAdaptor
- public interface CollabAppAdapter
Defines Collab Application API
Field Summary |
static java.lang.String |
COPYRIGHT
Copyright statement |
Method Summary |
boolean |
addCollabWorkspace(CollabWorkspaceInfo csbean)
Creates a collaborative workspace |
int |
addMember(java.lang.String cwId, java.lang.String memberDN, java.lang.String role)
Adds Group members to the collaborative workspace documents according to their access level |
int |
addMembers(CollabWorkspaceInfo csbean)
Adds Group members to the collaborative workspace documents according to their access level |
int |
addMembers(java.lang.String cwId, java.util.Vector memberDNs, java.lang.String role)
Adds Group members to the collaborative workspace documents according to their access level |
java.lang.String |
getCollabWorkspaceURL(java.lang.String cwId)
Returns the URL for a collaborative workspace |
java.util.Vector |
listTemplates()
Lists all the templates that are available on the collaborative application server |
boolean |
removeCollabWorkspace(java.lang.String cwId)
Removes a specific collaborative workspace |
int |
removeMember(java.lang.String cwId, java.lang.String memberDN)
Deletes Group members from the collaborative workspace |
int |
removeMembers(java.lang.String cwId, java.util.Vector memberDNs)
Deletes Group members from the collaborative workspace |
int |
setMemberRole(java.lang.String cwId, java.lang.String memberDN, java.lang.String role)
Changes the role of a member |
int |
setMembersRole(java.lang.String cwId, java.util.Vector memberDNs, java.lang.String role)
Changes the role of members |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- Copyright statement
- See Also:
- Constant Field Values
addCollabWorkspace
public boolean addCollabWorkspace(CollabWorkspaceInfo csbean)
throws ECException
- Creates a collaborative workspace
-
- Parameters:
- csbean - Collaborative workspace information
- Returns:
- true if successful, false otherwise
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
addMembers
public int addMembers(CollabWorkspaceInfo csbean)
throws ECException
- Adds Group members to the collaborative workspace documents according to their access level
-
- Parameters:
- csbean - Collaborative workspace information
- Returns:
- Number of members added
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
addMembers
public int addMembers(java.lang.String cwId,
java.util.Vector memberDNs,
java.lang.String role)
throws ECException
- Adds Group members to the collaborative workspace documents according to their access level
-
- Parameters:
- cwId - The collaborative workspace ID
- role - Role of the members, can be CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or CollabManager.ROLE_READER
- Returns:
- Number of members added
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
addMember
public int addMember(java.lang.String cwId,
java.lang.String memberDN,
java.lang.String role)
throws ECException
- Adds Group members to the collaborative workspace documents according to their access level
-
- Parameters:
- cwId - The collaborative workspace ID
- role - Role of the members, can be CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or CollabManager.ROLE_READER
- Returns:
- Number of members added
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
removeMembers
public int removeMembers(java.lang.String cwId,
java.util.Vector memberDNs)
throws ECException
- Deletes Group members from the collaborative workspace
-
- Parameters:
- cwId - The collaborative workspace ID
- memberDNs - Vector of member distinguished name (DN)
- Returns:
- Number of members removed
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
removeMember
public int removeMember(java.lang.String cwId,
java.lang.String memberDN)
throws ECException
- Deletes Group members from the collaborative workspace
-
- Parameters:
- cwId - The collaborative workspace ID
- memberDN - distinguished name (DN) of the member
- Returns:
- Number of members removed
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
setMembersRole
public int setMembersRole(java.lang.String cwId,
java.util.Vector memberDNs,
java.lang.String role)
throws ECException
- Changes the role of members
-
- Parameters:
- cwId - The collaborative workspace ID
- memberDNs - Vector of the member distinguished name (DN)
- role - Role of the members, can be CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or CollabManager.ROLE_READER
- Returns:
- Number of users changed
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
setMemberRole
public int setMemberRole(java.lang.String cwId,
java.lang.String memberDN,
java.lang.String role)
throws ECException
- Changes the role of a member
-
- Parameters:
- cwId - The collaborative workspace ID
- memberDN - distinguished name (DN) of the member
- role - Role of the members, can be CollabManager.ROLE_MANAGER, CollabManager.ROLE_AUTHOR or CollabManager.ROLE_READER
- Returns:
- Number of users changed
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
listTemplates
public java.util.Vector listTemplates()
- Lists all the templates that are available on the collaborative application server
-
- Returns:
- Vector of template names
removeCollabWorkspace
public boolean removeCollabWorkspace(java.lang.String cwId)
throws ECException
- Removes a specific collaborative workspace
-
- Parameters:
- cwId - The collaborative workspace ID
- Returns:
- true if successful, false otherwise
- Throws:
- java.lang.Exception - thrown by WebSphereCommerce
- ECException
getCollabWorkspaceURL
public java.lang.String getCollabWorkspaceURL(java.lang.String cwId)
- Returns the URL for a collaborative workspace
-
- Parameters:
- cwId - The collaborative workspace ID
- Returns:
- URL of the workspace
Feedback
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.