public interface IDiscussionAppSoap
Modifier and Type | Method and Description |
---|---|
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
|
Forum2SoapDO |
createForum2(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,
int emailPosting,
int emailMonitoring,
int webPosting,
java.lang.String captcha)
Creates a public 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. with multiple file attachment support.
|
PostSoapDO |
createPost2(java.lang.String sessionId,
java.lang.String parentPostId,
java.lang.String title,
java.lang.String message,
AttachmentSoapDO[] attachments,
java.lang.String ccRecipients)
Posts a new message to the discussion topic with multiple attachment support.
|
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
|
Forum2SoapDO |
createPrivateForum2(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,
int emailPosting,
int emailMonitoring,
int webPosting,
java.lang.String captcha)
Creates a private 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 |
TopicSoapDO |
createTopic2(java.lang.String sessionId,
java.lang.String forumId,
java.lang.String title,
java.lang.String message,
AttachmentSoapDO[] attachments,
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.
|
Forum2SoapList |
getForumList2(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.
|
ForumSoapList getForumList(java.lang.String sessionId, java.lang.String projectId) throws java.rmi.RemoteException
sessionId
- The user session idprojectId
- The id of the projectcom.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
Forum2SoapList getForumList2(java.lang.String sessionId, java.lang.String projectId) throws java.rmi.RemoteException
sessionId
- The user session idprojectId
- The id of the projectcom.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
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
createTopic
, this method lets you set the attachment files and cc email values at creation time and returns a TopicSoapData ObjectsessionId
- 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'dcom.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
TopicSoapDO createTopic2(java.lang.String sessionId, java.lang.String forumId, java.lang.String title, java.lang.String message, AttachmentSoapDO[] attachments, java.lang.String ccRecipients) throws java.rmi.RemoteException
createTopic
, this method lets you set the attachment files and cc email values at creation time and returns a TopicSoapData ObjectsessionId
- 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'dcom.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
void deleteTopic(java.lang.String sessionId, java.lang.String topicId) throws java.rmi.RemoteException
sessionId
- User session id.topicId
- The id of the topic to delete.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
TopicSoapList getTopicList(java.lang.String sessionId, java.lang.String forumId) throws java.rmi.RemoteException
sessionId
- The user session idforumId
- The id of the forum for which we want the topicscom.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
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
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'dcom.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
PostSoapDO createPost2(java.lang.String sessionId, java.lang.String parentPostId, java.lang.String title, java.lang.String message, AttachmentSoapDO[] attachments, java.lang.String ccRecipients) throws java.rmi.RemoteException
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'dcom.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
void deletePost(java.lang.String sessionId, java.lang.String postId) throws java.rmi.RemoteException
sessionId
- User session id.postId
- The id of the post to delete.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
PostSoapList getPostList(java.lang.String sessionId, java.lang.String topicId) throws java.rmi.RemoteException
sessionId
- User session id.topicId
- Topic id.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
PostSoapList findPosts(java.lang.String sessionId, java.lang.String queryString, java.lang.String projectId, boolean searchAttachments) throws java.rmi.RemoteException
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.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
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
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. 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 headermessageSize
- threshold size (MB) of message content and attachment of any posts in a forum. Set 0 for unlimited message size.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
Forum2SoapDO createForum2(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, int emailPosting, int emailMonitoring, int webPosting, java.lang.String captcha) throws java.rmi.RemoteException
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. 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 headermessageSize
- threshold size (MB) of message content and attachment of any posts in a forum. Set 0 for unlimited message size.emailPosting
- This will be ignored if mailing list is not enabled. The email posting setting for the forum, permissible values for this are: 0 - Allow only forum admins 1 - Users with roles and permissions 4 - All logged in users 5 - All known email addresses only 6 - Allow all site users and guestsemailMonitoring
- This will be ignored if mailing list is not enabled. The email monitoring setting for the forum, permissible values for this are: 0 - Allow only forum admins 1 - Users with roles and permissions 4 - All logged in users 5 - Allow all site users and guestswebPosting
- The web posting setting for the forum, permissible values for this are: 0 - Allow only forum admins 1 - Users with roles and permissions 2 - All logged in users 3 - Allow all site users and guestscaptcha
- whether CAPTCHA to be enforced for all web posts, only for logged-out users or for nobody. Permissible values for this are: "AL" - Use CAPTCHA for all web posts "AN" - Use CAPTCHA for anonymous web posts only "NO" - Do not use CAPTCHA for any web postscom.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
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
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. 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 headermessageSize
- threshold size of message content and attachment of any posts in a forumcom.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
Forum2SoapDO createPrivateForum2(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, int emailPosting, int emailMonitoring, int webPosting, java.lang.String captcha) throws java.rmi.RemoteException
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. 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 headermessageSize
- threshold size of message content and attachment of any posts in a forumemailPosting
- This will be ignored if mailing list is not enabled. The email posting setting for the forum, the permissible values are: 0 - Allow only forum admins 1 - Users with roles and permissions 4 - All logged in users 5 - All known email addresses onlyemailMonitoring
- This will be ignored if mailing list is not enabled. The email monitoring setting for the forum, the permissible values are: 0 - Allow only forum admins 1 - Users with roles and permissions 4 - All logged in userswebPosting
- The web posting setting for the forum, permissible values for this are: 0 - Allow only forum admins 1 - Users with roles and permissionscaptcha
- whether CAPTCHA to be enforced for all web posts, only for logged-out users or for nobody. Permissible values for this are: "AL" - Use CAPTCHA for all web posts "AN" - Use CAPTCHA for anonymous web posts only "NO" - Do not use CAPTCHA for any web postscom.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