com.vasoftware.sf.soap44.webservices.discussion
Interface IDiscussionAppSoap

public interface IDiscussionAppSoap

Provides SOAP services for managing forums, topics and posts.

Change History

Version 4.4: No changes.

Since:

4.1

Method Summary

PostSoapDO	createPost(java.lang.String sessionId, java.lang.String parentPostId, java.lang.String title, java.lang.String message) Posts a new message to the discussion topic.
TopicSoapDO	createTopic(java.lang.String sessionId, java.lang.String forumId, java.lang.String title, java.lang.String message) Creates a discussion topic within a specified forum.
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.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified project id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.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)
                        throws java.rmi.RemoteException

Creates a discussion topic within a specified forum.

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

Returns:

the TopicSoapData Object

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when one or more parameters are invalid.

com.vasoftware.sf.soap44.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.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.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.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.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)
                      throws java.rmi.RemoteException

Posts a new message to the discussion topic.

Parameters:

sessionId - The user session id.

parentPostId - Parent post to which this is a reply.

title - Post title.

message - Post message.

Returns:

Newly created post object data.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified parent post id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when one or more parameters are invalid.

com.vasoftware.sf.soap44.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.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when specified post id is the first post in a topic.

com.vasoftware.sf.soap44.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.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified topic id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.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.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified project id is invalid.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when query string is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.1