Package com.collabnet.ce.soap60.webservices.planning

Interface IPlanningAppSoap

    • Method Detail

      • createPlanningFolder

        PlanningFolderSoapDO createPlanningFolder​(String sessionId,
                                          String parentId,
                                          String title,
                                          String description,
                                          Date startDate,
                                          Date endDate,
                                          String status,
                                          int capacity,
                                          String releaseId)
                                   throws RemoteException
        Deprecated.
        in favor of createPlanningFolder4
        Creates a new planning folder
        Parameters:
        sessionId - User session id.
        parentId - The id of the project under which to create a new top-level planning folder
        title - The title of the new planning folder
        description - The description of the new planning folder
        startDate - The start date of the new planning folder
        endDate - The end date of the new planning folder
        status - The status of the new planning folder
        capacity - The capacity of the new planning folder
        releaseId - The release which is associated with the new planning folder
        Returns:
        the planning folder soap object
        Throws:
        InvalidSessionFault - when the specified session id is invalid.
        PermissionDeniedFault - when the user has insufficient privileges.
        SystemFault - when an unexpected system error occurs.
        NoSuchObjectFault - when the specified object id is invalid.
        ObjectAlreadyExistsFault - if an existing planning folder by that name already exists under the same parent
        IllegalArgumentFault - if invalid argument value was supplied.
        RemoteException
        Since:
        5.3

      • createPlanningFolder2

        PlanningFolder2SoapDO createPlanningFolder2​(String sessionId,
                                            String parentId,
                                            String title,
                                            String description,
                                            Date startDate,
                                            Date endDate,
                                            String status,
                                            int capacity,
                                            String releaseId,
                                            String trackerUnitId)
                                     throws RemoteException
        Deprecated.
        in favor of createPlanningFolder4
        Creates a new planning folder
        Parameters:
        sessionId - User session id.
        parentId - The id of the project under which to create a new top-level planning folder
        title - The title of the new planning folder
        description - The description of the new planning folder
        startDate - The start date of the new planning folder
        endDate - The end date of the new planning folder
        status - The status of the new planning folder
        capacity - The capacity of the new planning folder
        releaseId - The release which is associated with the new planning folder
        trackerUnitId - The tracker unit id
        Returns:
        the planning folder soap object
        Throws:
        InvalidSessionFault - when the specified session id is invalid.
        PermissionDeniedFault - when the user has insufficient privileges.
        SystemFault - when an unexpected system error occurs.
        NoSuchObjectFault - when the specified object id is invalid.
        ObjectAlreadyExistsFault - if an existing planning folder by that name already exists under the same parent
        IllegalArgumentFault - if invalid argument value was supplied.
        RemoteException
        Since:
        6.2

      • createPlanningFolder3

        PlanningFolder3SoapDO createPlanningFolder3​(String sessionId,
                                            String parentId,
                                            String title,
                                            String description,
                                            Date startDate,
                                            Date endDate,
                                            String status,
                                            int capacity,
                                            int pointsCapacity,
                                            String releaseId,
                                            String trackerUnitId)
                                     throws RemoteException
        Deprecated.
        in favor of createPlanningFolder4
        Creates a new planning folder
        Parameters:
        sessionId - User session id.
        parentId - The id of the project under which to create a new top-level planning folder
        title - The title of the new planning folder
        description - The description of the new planning folder
        startDate - The start date of the new planning folder
        endDate - The end date of the new planning folder
        status - The status of the new planning folder
        capacity - The efforts capacity of the new planning folder
        pointsCapacity - The points capacity of the new planning folder
        releaseId - The release which is associated with the new planning folder
        trackerUnitId - The tracker unit id
        Returns:
        the planning folder soap object
        Throws:
        InvalidSessionFault - when the specified session id is invalid.
        PermissionDeniedFault - when the user has insufficient privileges.
        SystemFault - when an unexpected system error occurs.
        NoSuchObjectFault - when the specified object id is invalid.
        ObjectAlreadyExistsFault - if an existing planning folder by that name already exists under the same parent
        IllegalArgumentFault - if invalid argument value was supplied.
        RemoteException
        Since:
        7.1

      • createPlanningFolder5

        PlanningFolder5SoapDO createPlanningFolder5​(String sessionId,
                                            String parentId,
                                            String type,
                                            String title,
                                            String description,
                                            Date startDate,
                                            Date endDate,
                                            String status,
                                            int capacity,
                                            int pointsCapacity,
                                            String releaseId,
                                            String trackerUnitId,
                                            String burndownViewMode)
                                     throws RemoteException
        Creates a new planning folder
        Parameters:
        sessionId - User session id.
        parentId - The id of the project under which to create a new top-level planning folder
        type - The type of the new planning folder
        title - The title of the new planning folder
        description - The description of the new planning folder
        startDate - The start date of the new planning folder
        endDate - The end date of the new planning folder
        status - The status of the new planning folder
        capacity - The efforts capacity of the new planning folder
        pointsCapacity - The points capacity of the new planning folder
        releaseId - The release which is associated with the new planning folder
        trackerUnitId - The tracker unit id
        burndownViewMode - The burn down view mode
        Returns:
        the planning folder soap object
        Throws:
        InvalidSessionFault - when the specified session id is invalid.
        PermissionDeniedFault - when the user has insufficient privileges.
        SystemFault - when an unexpected system error occurs.
        NoSuchObjectFault - when the specified object id is invalid.
        ObjectAlreadyExistsFault - if an existing planning folder by that name already exists under the same parent
        IllegalArgumentFault - if invalid argument value was supplied.
        RemoteException
        Since:
        8.2

      • getPlanningFolderSummaryList

        PlanningFolderSummarySoapList getPlanningFolderSummaryList​(String sessionId,
                                                           String parentId,
                                                           boolean recursive)
                                                    throws RemoteException
        Deprecated.
        in favor of getPlanningFolderSummary4List
        Returns the list of planning folders within the specified project including their statistics
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when invalid argument value is passed.
        RemoteException
        Since:
        5.3

      • getPlanningFolderSummary2List

        PlanningFolderSummary2SoapList getPlanningFolderSummary2List​(String sessionId,
                                                             String parentId,
                                                             boolean recursive)
                                                      throws RemoteException
        Deprecated.
        in favor of getPlanningFolderSummary4List
        Returns the list of planning folders within the specified project including their statistics
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when invalid argument value is passed.
        RemoteException
        Since:
        5.3

      • getPlanningFolderSummary3List

        PlanningFolderSummary3SoapList getPlanningFolderSummary3List​(String sessionId,
                                                             String parentId,
                                                             boolean recursive)
                                                      throws RemoteException
        Deprecated.
        in favor of getPlanningFolderSummary4List
        Returns the list of planning folders within the specified project including their statistics
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when invalid argument value is passed.
        RemoteException
        Since:
        7.1

      • getPlanningFolderSummary4List

        PlanningFolderSummary4SoapList getPlanningFolderSummary4List​(String sessionId,
                                                             String parentId,
                                                             boolean recursive)
                                                      throws RemoteException
        Returns the list of planning folders within the specified project including their statistics
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when invalid argument value is passed.
        RemoteException
        Since:
        7.2

      • getPlanningFolderSummary5List

        PlanningFolderSummary5SoapList getPlanningFolderSummary5List​(String sessionId,
                                                             String parentId,
                                                             boolean recursive)
                                                      throws RemoteException
        Returns the list of planning folders within the specified project including their statistics
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when invalid argument value is passed.
        RemoteException
        Since:
        8.2

      • getPlanningFolderList

        PlanningFolderSoapList getPlanningFolderList​(String sessionId,
                                             String parentId,
                                             boolean recursive)
                                      throws RemoteException
        Deprecated.
        in favor of getPlanningFolder4List
        Returns the list of planning folders within the specified project.
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when ivalid argument value is passed.
        RemoteException
        Since:
        5.3

      • getPlanningFolder2List

        PlanningFolder2SoapList getPlanningFolder2List​(String sessionId,
                                               String parentId,
                                               boolean recursive)
                                        throws RemoteException
        Deprecated.
        in favor of getPlanningFolder4List
        Returns the list of planning folders within the specified project.
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when ivalid argument value is passed.
        RemoteException
        Since:
        6.2

      • getPlanningFolder3List

        PlanningFolder3SoapList getPlanningFolder3List​(String sessionId,
                                               String parentId,
                                               boolean recursive)
                                        throws RemoteException
        Deprecated.
        in favor of getPlanningFolder4List
        Returns the list of planning folders within the specified project.
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when ivalid argument value is passed.
        RemoteException
        Since:
        7.1

      • getPlanningFolder4List

        PlanningFolder4SoapList getPlanningFolder4List​(String sessionId,
                                               String parentId,
                                               boolean recursive)
                                        throws RemoteException
        Returns the list of planning folders within the specified project.
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when ivalid argument value is passed.
        RemoteException
        Since:
        7.2

      • getPlanningFolder5List

        PlanningFolder5SoapList getPlanningFolder5List​(String sessionId,
                                               String parentId,
                                               boolean recursive)
                                        throws RemoteException
        Returns the list of planning folders within the specified project.
        Parameters:
        sessionId - User session id.
        parentId - Parent planning folder id -or- project id for listing all top-level planning folders.
        recursive - Show subfolders of the planning folders returned
        Returns:
        List of filtered planning folder
        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.
        IllegalArgumentFault - when ivalid argument value is passed.
        RemoteException
        Since:
        8.2

      • getArtifactListInPlanningFolder

        ArtifactsInPlanningFolderSoapList getArtifactListInPlanningFolder​(String sessionId,
                                                                  String parentId,
                                                                  SoapFilter[] filters,
                                                                  boolean recursive)
                                                           throws RemoteException
        Deprecated.
        in favor of getArtifactListInPlanningFolder2
        /**

        Returns the list of artifacts contained in a planning folder or its descendants.

        Parameters:
        sessionId - User session id.
        parentId - parentId
        recursive - indicates if descendents planning folder artifacts will be included in the result
        filters - Array of filters to apply (null to return unfiltered list).
        Returns:
        List of artifacts contained in the planning folder/its descendents or artifacts not planned yet.
        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.
        InvalidFilterFault - when the specified filters are invalid.
        IllegalArgumentFault - if invalid argument value is passed.
        RemoteException
        Since:
        5.3

      • getArtifactListInPlanningFolder2

        ArtifactsInPlanningFolder2SoapList getArtifactListInPlanningFolder2​(String sessionId,
                                                                    String parentId,
                                                                    SoapFilter[] filters,
                                                                    boolean recursive)
                                                             throws RemoteException
        Returns the list of artifacts contained in a planning folder or its descendants.
        Parameters:
        sessionId - User session id.
        parentId - if parentId is a planning folder id, this method will return artifacts that are part of this planning folder
        recursive - indicates if descendents planning folder artifacts will be included in the result
        filters - Array of filters to apply (null to return unfiltered list).
        Returns:
        List of artifacts contained in the planning folder/its descendents or artifacts not planned yet.
        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.
        InvalidFilterFault - when the specified filters are invalid.
        IllegalArgumentFault - if invalid argument value is passed.
        RemoteException
        Since:
        8.0

      • getArtifactListInPlanningFolder3

        ArtifactsInPlanningFolder2SoapList getArtifactListInPlanningFolder3​(String sessionId,
                                                                    String parentId,
                                                                    SoapFilter[] filters,
                                                                    boolean recursive,
                                                                    String[] teamId)
                                                             throws RemoteException
        Returns the list of artifacts contained in a planning folder or its descendants.
        Parameters:
        sessionId - User session id.
        parentId - if parentId is a planning folder id, this method will return artifacts that are part of this planning folder
        recursive - indicates if descendents planning folder artifacts will be included in the result
        filters - Array of filters to apply (null to return unfiltered list).
        teamId - if teamId is specified it shows the list of artifacts in that team
        Returns:
        List of artifacts contained in the planning folder/its descendents or artifacts not planned yet.
        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.
        InvalidFilterFault - when the specified filters are invalid.
        IllegalArgumentFault - if invalid argument value is passed.
        RemoteException
        Since:
        17.1

      • getRankedArtifactList

        RankedArtifactSoapList getRankedArtifactList​(String sessionId,
                                             String planningFolderId)
                                      throws RemoteException
        Deprecated.
        in favor of getRankedArtifactList2
        Returns the list of artifacts assigned to a planning folder or its descendants with the rank information in the specified planning folder
        Parameters:
        sessionId - User session id.
        planningFolderId - this method will return artifacts that are part of this planning folder
        Returns:
        List of artifacts contained in the planning folder
        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.
        InvalidFilterFault - when the specified filters are invalid.
        IllegalArgumentFault - if invalid argument value is passed.
        RemoteException
        Since:
        5.4

      • reorderPlanningFolders

        void reorderPlanningFolders​(String sessionId,
                            String parentId,
                            String[] planningFolderIds)
                     throws RemoteException
        Sets a new order for the planning folders in their parent folder.
        Parameters:
        sessionId - User session id.
        parentId - the id of the parent planning folder
        planningFolderIds - an array of planning folder ids in their new order
        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 level error occurs.
        IllegalArgumentFault - if invalid argument value is passed.
        RemoteException
        Since:
        5.3

      • getPlanningStatusValues

        PlanningStatusValueSoapDO[] getPlanningStatusValues​(String sessionId,
                                                    String projectId)
                                             throws RemoteException
        Gets status values for the planning application of a specific project.
        Parameters:
        sessionId - User session id.
        projectId - Project for which to set the planning application status values.
        Returns:
        Status values for the planning application.
        Throws:
        NoSuchObjectFault - when failed to get status field for the given project
        InvalidSessionFault - when the specified session id is invalid.
        PermissionDeniedFault - when the user has insufficient privileges.
        SystemFault - when an unexpected system error occurs.
        RemoteException
        Since:
        5.4