Interface IDiscussionAppSoap
- All Known Implementing Classes:
DiscussionAppSoap
,DiscussionAppSoapMockStub
,DiscussionAppSoapStub
public interface IDiscussionAppSoap
-
Method Summary
Modifier and TypeMethodDescriptioncreateForum
(String sessionId, String projectId, String listName, String forumName, String description, boolean listEnabled, String prefix, String footer, String forumType, String[] moderators, String[] trustedUsers, String replyTo, int messageSize) Creates a discussion forumcreateForum2
(String sessionId, String projectId, String listName, String forumName, String description, boolean listEnabled, String prefix, String footer, String forumType, String[] moderators, String[] trustedUsers, String replyTo, int messageSize, int emailPosting, int emailMonitoring, int webPosting, String captcha) Creates a public discussion forumcreatePost
(String sessionId, String parentPostId, String title, String message, String attachmentFileName, String attachmentMimeType, String attachmentFileId, String ccRecipients) Posts a new message to the discussion topic.createPost2
(String sessionId, String parentPostId, String title, String message, AttachmentSoapDO[] attachments, String ccRecipients) Posts a new message to the discussion topic with multiple attachment support.createPrivateForum
(String sessionId, String projectId, String listName, String forumName, String description, boolean listEnabled, String prefix, String footer, String forumType, String[] moderators, String[] trustedUsers, String replyTo, int messageSize) Creates a discussion forumcreatePrivateForum2
(String sessionId, String projectId, String listName, String forumName, String description, boolean listEnabled, String prefix, String footer, String forumType, String[] moderators, String[] trustedUsers, String replyTo, int messageSize, int emailPosting, int emailMonitoring, int webPosting, String captcha) Creates a private discussion forumcreateTopic
(String sessionId, String forumId, String title, String message, String attachmentFileName, String attachmentMimeType, String attachmentFileId, String ccRecipients) Creates a new discussion topic within a specified forum but unlikecreateTopic
createTopic2
(String sessionId, String forumId, String title, String message, AttachmentSoapDO[] attachments, String ccRecipients) Creates a new discussion topic within a specified forum but unlikecreateTopic
void
deletePost
(String sessionId, String postId) Deletes the specified post.void
deleteTopic
(String sessionId, String topicId) Deletes the specified topic.Finds a list of posts matching a search string.getForumList
(String sessionId, String projectId) Returns a list of forums within a specified project.getForumList2
(String sessionId, String projectId) Returns a list of forums within a specified project.getPostList
(String sessionId, String topicId) Returns a list of posts associated with a specified topic.getTopicList
(String sessionId, String forumId) Gets a list of all topics in a forum.
-
Method Details
-
getForumList
Returns a list of forums within a specified project.- Parameters:
sessionId
- The user session idprojectId
- The id of the project- Returns:
- The list of forums within the specified project
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified project id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.1
-
getForumList2
Returns a list of forums within a specified project.- Parameters:
sessionId
- The user session idprojectId
- The id of the project- Returns:
- The list of forums within the specified project
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified project id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 6.2
-
createTopic
TopicSoapDO createTopic(String sessionId, String forumId, String title, String message, String attachmentFileName, String attachmentMimeType, String attachmentFileId, String ccRecipients) throws RemoteException Creates a new discussion topic within a specified forum but unlikecreateTopic
- Parameters:
sessionId
- User session id.forumId
- The id of the forum in which to create a topic.title
- The topic titlemessage
- The content for the first post of this topicattachmentFileName
- 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 nullccRecipients
- list of recipients to whom the mail should be cc'd- Returns:
- the TopicSoapData Object
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.IllegalArgumentFault
- when one or more parameters are invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.1
-
createTopic2
TopicSoapDO createTopic2(String sessionId, String forumId, String title, String message, AttachmentSoapDO[] attachments, String ccRecipients) throws RemoteException Creates a new discussion topic within a specified forum but unlikecreateTopic
- Parameters:
sessionId
- User session id.forumId
- The id of the forum in which to create a topic.title
- The topic titlemessage
- The content for the first post of this topicattachments
- List of attachment Files.ccRecipients
- list of recipients to whom the mail should be cc'd- Returns:
- the TopicSoapData Object
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.IllegalArgumentFault
- when one or more parameters are invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 6.2
-
deleteTopic
Deletes the specified topic.- Parameters:
sessionId
- User session id.topicId
- The id of the topic to delete.- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.1
-
getTopicList
Gets a list of all topics in a forum.- Parameters:
sessionId
- The user session idforumId
- The id of the forum for which we want the topics- Returns:
- The TopicSummarySoapList of all topics in the forum
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.1
-
createPost
PostSoapDO createPost(String sessionId, String parentPostId, String title, String message, String attachmentFileName, String attachmentMimeType, String attachmentFileId, String ccRecipients) throws 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.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 nullccRecipients
- list of recipients to whom the mail should be cc'd- Returns:
- Newly created post object data.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified parent post id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.IllegalArgumentFault
- when one or more parameters are invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.1
-
createPost2
PostSoapDO createPost2(String sessionId, String parentPostId, String title, String message, AttachmentSoapDO[] attachments, String ccRecipients) throws RemoteException Posts a new message to the discussion topic with multiple attachment support.- Parameters:
sessionId
- The user session id.parentPostId
- Parent post to which this is a reply.title
- Post title.message
- Post message.attachments
- List of attachment files.ccRecipients
- list of recipients to whom the mail should be cc'd- Returns:
- Newly created post object data.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified parent post id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.IllegalArgumentFault
- when one or more parameters are invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 6.2
-
deletePost
Deletes the specified post.- Parameters:
sessionId
- User session id.postId
- The id of the post to delete.- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.IllegalArgumentFault
- when specified post id is the first post in a topic.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.1
-
getPostList
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:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified topic id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system level error occurs.RemoteException
- Since:
- 4.1
-
findPosts
PostSoapList findPosts(String sessionId, String queryString, String projectId, boolean searchAttachments) throws 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:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified project id is invalid.IllegalArgumentFault
- when query string is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SearchQuerySyntaxFault
- when the specified search query string is syntactically invalid.SystemFault
- when an unexpected system level error occurs.RemoteException
- Since:
- 4.1
-
createForum
ForumSoapDO createForum(String sessionId, String projectId, String listName, String forumName, String description, boolean listEnabled, String prefix, String footer, String forumType, String[] moderators, String[] trustedUsers, String replyTo, int messageSize) throws RemoteException Creates a discussion forum- Parameters:
sessionId
- User session idprojectId
- the project in which the forum is to be createdlistName
- name of the associated mailing listforumName
- Name for the forumdescription
- description of the forumlistEnabled
- is a mailing list enabled with this forumprefix
- prefix to be added to the subject of all posts to this forumfooter
- footer to be appended to the bottom of every mail in this forumforumType
- 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.messageSize
- threshold size (MB) of message content and attachment of any posts in a forum.- Returns:
- a data object of the created forum
- Throws:
SystemFault
- when an unexpected system level error occurs.IllegalArgumentFault
- thrown when the given parameters are invalid.InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified project id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.ObjectAlreadyExistsFault
- when an object by this name already exists in the project.InvalidForumTypeFault
- when type is other than MF or UF.RemoteException
- Since:
- 6.0
-
createForum2
Forum2SoapDO createForum2(String sessionId, String projectId, String listName, String forumName, String description, boolean listEnabled, String prefix, String footer, String forumType, String[] moderators, String[] trustedUsers, String replyTo, int messageSize, int emailPosting, int emailMonitoring, int webPosting, String captcha) throws RemoteException Creates a public discussion forum- Parameters:
sessionId
- User session idprojectId
- the project in which the forum is to be createdlistName
- name of the associated mailing listforumName
- Name for the forumdescription
- description of the forumlistEnabled
- is a mailing list enabled with this forumprefix
- prefix to be added to the subject of all posts to this forumfooter
- footer to be appended to the bottom of every mail in this forumforumType
- 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.messageSize
- threshold size (MB) of message content and attachment of any posts in a forum.emailPosting
- This will be ignored if mailing list is not enabled.emailMonitoring
- This will be ignored if mailing list is not enabled.webPosting
- The web posting setting for the forumcaptcha
- whether CAPTCHA to be enforced for all web posts, only for logged-out users or for nobody.- Returns:
- a data object of the created forum
- Throws:
SystemFault
- when an unexpected system level error occurs.IllegalArgumentFault
- thrown when the given parameters are invalid.InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified project id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.ObjectAlreadyExistsFault
- when an object by this name already exists in the project.InvalidForumTypeFault
- when type is other than MF or UF.RemoteException
- Since:
- 6.2
-
createPrivateForum
ForumSoapDO createPrivateForum(String sessionId, String projectId, String listName, String forumName, String description, boolean listEnabled, String prefix, String footer, String forumType, String[] moderators, String[] trustedUsers, String replyTo, int messageSize) throws RemoteException Creates a discussion forum- Parameters:
sessionId
- User session idprojectId
- the project in which the forum is to be createdlistName
- name of the associated mailing listforumName
- Name for the forumdescription
- description of the forumlistEnabled
- is a mailing list enabled with this forumprefix
- prefix to be added to the subject of all posts to this forumfooter
- footer to be appended to the bottom of every mail in this forumforumType
- 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.messageSize
- threshold size of message content and attachment of any posts in a forum- Returns:
- a data object of the created forum
- Throws:
SystemFault
- when an unexpected system level error occurs.IllegalArgumentFault
- thrown when the given parameters are invalid.InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified project id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.ObjectAlreadyExistsFault
- when an object by this name already exists in the project.InvalidForumTypeFault
- when type is other than MF or UF.RemoteException
- Since:
- 6.0.1
-
createPrivateForum2
Forum2SoapDO createPrivateForum2(String sessionId, String projectId, String listName, String forumName, String description, boolean listEnabled, String prefix, String footer, String forumType, String[] moderators, String[] trustedUsers, String replyTo, int messageSize, int emailPosting, int emailMonitoring, int webPosting, String captcha) throws RemoteException Creates a private discussion forum- Parameters:
sessionId
- User session idprojectId
- the project in which the forum is to be createdlistName
- name of the associated mailing listforumName
- Name for the forumdescription
- description of the forumlistEnabled
- is a mailing list enabled with this forumprefix
- prefix to be added to the subject of all posts to this forumfooter
- footer to be appended to the bottom of every mail in this forumforumType
- 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.messageSize
- threshold size of message content and attachment of any posts in a forumemailPosting
- This will be ignored if mailing list is not enabled.emailMonitoring
- This will be ignored if mailing list is not enabled.webPosting
- The web posting setting for the forumcaptcha
- whether CAPTCHA to be enforced for all web posts, only for logged-out users or for nobody.- Returns:
- a data object of the created forum
- Throws:
SystemFault
- when an unexpected system level error occurs.IllegalArgumentFault
- thrown when the given parameters are invalid.InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified project id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.ObjectAlreadyExistsFault
- when an object by this name already exists in the project.InvalidForumTypeFault
- when type is other than MF or UF.RemoteException
- Since:
- 6.2
-