Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.collabnet.ce.soap60.webservices.discussion
Interface IDiscussionAppSoap

public interface IDiscussionAppSoap

Provides SOAP services for managing forums, topics and posts.

Change History
Version 6.1
Version 6.0.1
Version 6.0
Version 4.4: No changes.

Since:
4.1

Method Summary
 ForumSoapDO createForum(java.lang.String sessionId, java.lang.String projectId, java.lang.String listName, java.lang.String forumName, java.lang.String description, boolean listEnabled, java.lang.String prefix, java.lang.String footer, java.lang.String forumType, java.lang.String[] moderators, java.lang.String[] trustedUsers, java.lang.String replyTo, int messageSize)
          Creates a discussion forum
 PostSoapDO createPost(java.lang.String sessionId, java.lang.String parentPostId, java.lang.String title, java.lang.String message, java.lang.String attachmentFileName, java.lang.String attachmentMimeType, java.lang.String attachmentFileId, java.lang.String ccRecipients)
          Posts a new message to the discussion topic.
 ForumSoapDO createPrivateForum(java.lang.String sessionId, java.lang.String projectId, java.lang.String listName, java.lang.String forumName, java.lang.String description, boolean listEnabled, java.lang.String prefix, java.lang.String footer, java.lang.String forumType, java.lang.String[] moderators, java.lang.String[] trustedUsers, java.lang.String replyTo, int messageSize)
          Creates a discussion forum
 TopicSoapDO createTopic(java.lang.String sessionId, java.lang.String forumId, java.lang.String title, java.lang.String message, java.lang.String attachmentFileName, java.lang.String attachmentMimeType, java.lang.String attachmentFileId, java.lang.String ccRecipients)
          Creates a new discussion topic within a specified forum but unlike createTopic, this method lets you set the attachment files and cc email values at creation time and returns a TopicSoapData Object
 void deletePost(java.lang.String sessionId, java.lang.String postId)
          Deletes the specified post.
 void deleteTopic(java.lang.String sessionId, java.lang.String topicId)
          Deletes the specified topic.
 PostSoapList findPosts(java.lang.String sessionId, java.lang.String queryString, java.lang.String projectId, boolean searchAttachments)
          Finds a list of posts matching a search string.
 ForumSoapList getForumList(java.lang.String sessionId, java.lang.String projectId)
          Returns a list of forums within a specified project.
 PostSoapList getPostList(java.lang.String sessionId, java.lang.String topicId)
          Returns a list of posts associated with a specified topic.
 TopicSoapList getTopicList(java.lang.String sessionId, java.lang.String forumId)
          Gets a list of all topics in a forum.
 

Method Detail

getForumList

ForumSoapList getForumList(java.lang.String sessionId,
                           java.lang.String projectId)
                           throws java.rmi.RemoteException
Returns a list of forums within a specified project.

Parameters:
sessionId - The user session id
projectId - The id of the project
Returns:
The list of forums within the specified project
Throws:
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

createTopic

TopicSoapDO createTopic(java.lang.String sessionId,
                        java.lang.String forumId,
                        java.lang.String title,
                        java.lang.String message,
                        java.lang.String attachmentFileName,
                        java.lang.String attachmentMimeType,
                        java.lang.String attachmentFileId,
                        java.lang.String ccRecipients)
                        throws java.rmi.RemoteException
Creates a new discussion topic within a specified forum but unlike createTopic, this method lets you set the attachment files and cc email values at creation time and returns a TopicSoapData Object

Parameters:
sessionId - User session id.
forumId - The id of the forum in which to create a topic.
title - The topic title
message - The content for the first post of this topic
attachmentFileName - Name of the attached file (or null)
attachmentMimeType - Mime type of the attached file (or null)
attachmentFileId - ID of the attached file (previously uploaded via *FileStorage service) or null
ccRecipients - list of recipients to whom the mail should be cc'd
Returns:
the TopicSoapData Object
Throws:
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more parameters are invalid.
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

deleteTopic

void deleteTopic(java.lang.String sessionId,
                 java.lang.String topicId)
                 throws java.rmi.RemoteException
Deletes the specified topic.

Parameters:
sessionId - User session id.
topicId - The id of the topic to delete.
Throws:
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

getTopicList

TopicSoapList getTopicList(java.lang.String sessionId,
                           java.lang.String forumId)
                           throws java.rmi.RemoteException
Gets a list of all topics in a forum.

Parameters:
sessionId - The user session id
forumId - The id of the forum for which we want the topics
Returns:
The TopicSummarySoapList of all topics in the forum
Throws:
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

createPost

PostSoapDO createPost(java.lang.String sessionId,
                      java.lang.String parentPostId,
                      java.lang.String title,
                      java.lang.String message,
                      java.lang.String attachmentFileName,
                      java.lang.String attachmentMimeType,
                      java.lang.String attachmentFileId,
                      java.lang.String ccRecipients)
                      throws java.rmi.RemoteException
Posts a new message to the discussion topic. It also lets you set the attachment files and cc email values at creation time and returns a PostSoapData Object.

Parameters:
sessionId - The user session id.
parentPostId - Parent post to which this is a reply.
title - Post title.
message - Post message.
attachmentFileName - Name of the attached file (or null)
attachmentMimeType - Mime type of the attached file (or null)
attachmentFileId - ID of the attached file (previously uploaded via *FileStorage service) or null
ccRecipients - list of recipients to whom the mail should be cc'd
Returns:
Newly created post object data.
Throws:
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified parent post id is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more parameters are invalid.
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

deletePost

void deletePost(java.lang.String sessionId,
                java.lang.String postId)
                throws java.rmi.RemoteException
Deletes the specified post.

Parameters:
sessionId - User session id.
postId - The id of the post to delete.
Throws:
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.IllegalArgumentFault - when specified post id is the first post in a topic.
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

getPostList

PostSoapList getPostList(java.lang.String sessionId,
                         java.lang.String topicId)
                         throws java.rmi.RemoteException
Returns a list of posts associated with a specified topic.

Parameters:
sessionId - User session id.
topicId - Topic id.
Returns:
List of posts on this topic.
Throws:
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified topic id is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
java.rmi.RemoteException
Since:
4.1

findPosts

PostSoapList findPosts(java.lang.String sessionId,
                       java.lang.String queryString,
                       java.lang.String projectId,
                       boolean searchAttachments)
                       throws java.rmi.RemoteException
Finds a list of posts matching a search string.

Parameters:
sessionId - User session id.
queryString - Query string.
projectId - The project in which to find posts. (if null, search all projects)
searchAttachments - Whether to search attachments.
Returns:
List of posts matching search criteria.
Throws:
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.
com.collabnet.ce.soap60.fault.IllegalArgumentFault - when query string is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
java.rmi.RemoteException
Since:
4.1

createForum

ForumSoapDO createForum(java.lang.String sessionId,
                        java.lang.String projectId,
                        java.lang.String listName,
                        java.lang.String forumName,
                        java.lang.String description,
                        boolean listEnabled,
                        java.lang.String prefix,
                        java.lang.String footer,
                        java.lang.String forumType,
                        java.lang.String[] moderators,
                        java.lang.String[] trustedUsers,
                        java.lang.String replyTo,
                        int messageSize)
                        throws java.rmi.RemoteException
Creates a discussion forum

Parameters:
sessionId - User session id
projectId - the project in which the forum is to be created
listName - name of the associated mailing list
forumName - Name for the forum
description - description of the forum
listEnabled - is a mailing list enabled with this forum
prefix - prefix to be added to the subject of all posts to this forum
footer - footer to be appended to the bottom of every mail in this forum
forumType - whether the forum should be moderated. Moderated -'MF'; Unmoderated - 'UF'
moderators - The userId's for persons to be added as moderators for this forum.
trustedUsers - The userId's for persons to be added as trusted for this forum.
replyTo - The value of reply header for the post's mail in this forum. The following are available options: "REPLYTOSENDER" Add sender's mail address as replyto header "REPLYTOLIST" Add list name as replyto header "NOREPLYTO" Do not add replyto header "xxx@host.domain" Add the given email address as replyto header
messageSize - threshold size (MB) of message content and attachment of any posts in a forum. Set 0 for unlimited message size.
Returns:
a data object of the created forum
Throws:
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
com.collabnet.ce.soap60.fault.IllegalArgumentFault - thrown when the given parameters are invalid.
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when an object by this name already exists in the project.
com.collabnet.ce.soap60.fault.InvalidForumTypeFault - when type is other than MF or UF.
java.rmi.RemoteException
Since:
6.0

createPrivateForum

ForumSoapDO createPrivateForum(java.lang.String sessionId,
                               java.lang.String projectId,
                               java.lang.String listName,
                               java.lang.String forumName,
                               java.lang.String description,
                               boolean listEnabled,
                               java.lang.String prefix,
                               java.lang.String footer,
                               java.lang.String forumType,
                               java.lang.String[] moderators,
                               java.lang.String[] trustedUsers,
                               java.lang.String replyTo,
                               int messageSize)
                               throws java.rmi.RemoteException
Creates a discussion forum

Parameters:
sessionId - User session id
projectId - the project in which the forum is to be created
listName - name of the associated mailing list
forumName - Name for the forum
description - description of the forum
listEnabled - is a mailing list enabled with this forum
prefix - prefix to be added to the subject of all posts to this forum
footer - footer to be appended to the bottom of every mail in this forum
forumType - whether the forum should be moderated. Moderated -'MF'; Unmoderated - 'UF'
moderators - The userId's for persons to be added as moderators for this forum.
trustedUsers - The userId's for persons to be added as trusted for this forum.
replyTo - The value of reply header for the post's mail in this forum. The following are available options: "REPLYTOSENDER" Add sender's mail address as replyto header "REPLYTOLIST" Add list name as replyto header "NOREPLYTO" Do not add replyto header "xxx@host.domain" Add the given email address as replyto header
messageSize - threshold size of message content and attachment of any posts in a forum
Returns:
a data object of the created forum
Throws:
com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
com.collabnet.ce.soap60.fault.IllegalArgumentFault - thrown when the given parameters are invalid.
com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.
com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when an object by this name already exists in the project.
com.collabnet.ce.soap60.fault.InvalidForumTypeFault - when type is other than MF or UF.
java.rmi.RemoteException
Since:
6.0.1
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD