Package com.collabnet.ce.soap60.webservices.discussion

Class DiscussionAppSoapStub

    • Constructor Detail

      • DiscussionAppSoapStub

        public DiscussionAppSoapStub​(String soapServerUrl)

    • Method Detail

      • createTopic

        public TopicSoapDO createTopic​(String sessionId,
                               String forumId,
                               String title,
                               String message,
                               String attachmentFileName,
                               String attachmentMimeType,
                               String attachmentFileId,
                               String ccRecipients)
                        throws RemoteException
        Description copied from interface: IDiscussionAppSoap
        Creates a new discussion topic within a specified forum but unlike createTopic
        Specified by:
        createTopic in interface IDiscussionAppSoap
        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:
        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

      • createPost

        public PostSoapDO createPost​(String sessionId,
                             String parentPostId,
                             String title,
                             String message,
                             String attachmentFileName,
                             String attachmentMimeType,
                             String attachmentFileId,
                             String ccRecipients)
                      throws RemoteException
        Description copied from interface: IDiscussionAppSoap
        Posts a new message to the discussion topic.
        Specified by:
        createPost in interface IDiscussionAppSoap
        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:
        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

      • createForum

        public 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
        Description copied from interface: IDiscussionAppSoap
        Creates a discussion forum
        Specified by:
        createForum in interface IDiscussionAppSoap
        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.
        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

      • createForum2

        public 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
        Description copied from interface: IDiscussionAppSoap
        Creates a public discussion forum
        Specified by:
        createForum2 in interface IDiscussionAppSoap
        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.
        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 forum
        captcha - 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

      • createPrivateForum

        public 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
        Description copied from interface: IDiscussionAppSoap
        Creates a discussion forum
        Specified by:
        createPrivateForum in interface IDiscussionAppSoap
        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.
        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

      • createPrivateForum2

        public 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
        Description copied from interface: IDiscussionAppSoap
        Creates a private discussion forum
        Specified by:
        createPrivateForum2 in interface IDiscussionAppSoap
        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.
        messageSize - threshold size 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 forum
        captcha - 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