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

# Class PlanningAppSoapStub

java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.planning.PlanningAppSoapStub

All Implemented Interfaces:
  `IPlanningAppSoap`

public class PlanningAppSoapStub extends ClientSoapStub implements IPlanningAppSoap

- ## Field Summary

  ### Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub

  `DEFAULT_CLIENT_TIME_OUT`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `PlanningAppSoapStub(String soapServerUrl)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `PlanningFolderSoapDO`
  `createPlanningFolder(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, String releaseId)`
  Creates a new planning folder
  `PlanningFolder2SoapDO`
  `createPlanningFolder2(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, String releaseId, String trackerUnitId)`
  Creates a new planning folder
  `PlanningFolder3SoapDO`
  `createPlanningFolder3(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, int pointsCapacity, String releaseId, String trackerUnitId)`
  Creates a new planning folder
  `PlanningFolder4SoapDO`
  `createPlanningFolder4(String sessionId, String parentId, PlanningFolder4SoapDO soapDO)`
  Creates a new planning folder
  `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)`
  Creates a new planning folder
  `void`
  `deletePlanningFolder(String sessionId, String planningFolderId)`
  Deletes a planning folder with the specified id.
  `ArtifactsInPlanningFolderSoapList`
  `getArtifactListInPlanningFolder(String sessionId, String parentId, SoapFilter[] filters, boolean recursive)`
  /**
  `ArtifactsInPlanningFolder2SoapList`
  `getArtifactListInPlanningFolder2(String sessionId, String parentId, SoapFilter[] filters, boolean recursive)`
  Returns the list of artifacts contained in a planning folder or its descendants.
  `ArtifactsInPlanningFolder2SoapList`
  `getArtifactListInPlanningFolder3(String sessionId, String parentId, SoapFilter[] filters, boolean recursive, String[] teamId)`
  Returns the list of artifacts contained in a planning folder or its descendants.
  `PlanningFolder2SoapDO`
  `getPlanningFolder2Data(String sessionId, String planningFolderId)`
  Returns a data object for a given planning folder
  `PlanningFolder2SoapList`
  `getPlanningFolder2List(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project.
  `PlanningFolder3SoapDO`
  `getPlanningFolder3Data(String sessionId, String planningFolderId)`
  Returns a data object for a given planning folder
  `PlanningFolder3SoapList`
  `getPlanningFolder3List(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project.
  `PlanningFolder4SoapDO`
  `getPlanningFolder4Data(String sessionId, String planningFolderId)`
  Returns a data object for a given planning folder
  `PlanningFolder4SoapList`
  `getPlanningFolder4List(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project.
  `PlanningFolder5SoapDO`
  `getPlanningFolder5Data(String sessionId, String planningFolderId)`
  Returns a data object for a given planning folder
  `PlanningFolder5SoapList`
  `getPlanningFolder5List(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project.
  `PlanningFolderSoapDO`
  `getPlanningFolderData(String sessionId, String planningFolderId)`
  Returns a data object for a given planning folder
  `PlanningFolderSoapList`
  `getPlanningFolderList(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project.
  `PlanningFolderSummarySoapDO`
  `getPlanningFolderSummary(String sessionId, String planningFolderId)`
  Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
  `PlanningFolderSummary2SoapDO`
  `getPlanningFolderSummary2(String sessionId, String planningFolderId)`
  Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
  `PlanningFolderSummary2SoapList`
  `getPlanningFolderSummary2List(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project including their statistics
  `PlanningFolderSummary3SoapDO`
  `getPlanningFolderSummary3(String sessionId, String planningFolderId)`
  Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
  `PlanningFolderSummary3SoapList`
  `getPlanningFolderSummary3List(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project including their statistics
  `PlanningFolderSummary4SoapDO`
  `getPlanningFolderSummary4(String sessionId, String planningFolderId)`
  Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
  `PlanningFolderSummary4SoapList`
  `getPlanningFolderSummary4List(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project including their statistics
  `PlanningFolderSummary5SoapDO`
  `getPlanningFolderSummary5(String sessionId, String planningFolderId)`
  Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
  `PlanningFolderSummary5SoapList`
  `getPlanningFolderSummary5List(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project including their statistics
  `PlanningFolderSummarySoapList`
  `getPlanningFolderSummaryList(String sessionId, String parentId, boolean recursive)`
  Returns the list of planning folders within the specified project including their statistics
  `PlanningStatusValueSoapDO[]`
  `getPlanningStatusValues(String sessionId, String projectId)`
  Gets status values for the planning application of a specific project.
  `RankedArtifactSoapList`
  `getRankedArtifactList(String sessionId, String planningFolderId)`
  Returns the list of artifacts assigned to a planning folder or its descendants with the rank information in the specified planning folder
  `RankedArtifact2SoapList`
  `getRankedArtifactList2(String sessionId, String planningFolderId)`
  Returns the list of artifacts assigned to a planning folder
  `PlanningFolderSoapDO`
  `movePlanningFolder(String sessionId, String planningFolderId, String destParentId)`
  Moves a Planning Folder including its sub folders and contents.
  `PlanningFolder2SoapDO`
  `movePlanningFolder2(String sessionId, String planningFolderId, String destParentId)`
  Moves a Planning Folder including its sub folders and contents.
  `PlanningFolder3SoapDO`
  `movePlanningFolder3(String sessionId, String planningFolderId, String destParentId)`
  Moves a Planning Folder including its sub folders and contents.
  `PlanningFolder4SoapDO`
  `movePlanningFolder4(String sessionId, String planningFolderId, String destParentId)`
  Moves a Planning Folder including its sub folders and contents.
  `PlanningFolder5SoapDO`
  `movePlanningFolder5(String sessionId, String planningFolderId, String destParentId)`
  Moves a Planning Folder including its sub folders and contents.
  `void`
  `reorderPlanningFolders(String sessionId, String parentId, String[] planningFolderIds)`
  Sets a new order for the planning folders in their parent folder.
  `void`
  `setPlanningFolder2Data(String sessionId, PlanningFolder2SoapDO planningFolderData)`
  Sets data on a specific planning folder.
  `void`
  `setPlanningFolder3Data(String sessionId, PlanningFolder3SoapDO planningFolderData)`
  Sets data on a specific planning folder.
  `void`
  `setPlanningFolder4Data(String sessionId, PlanningFolder4SoapDO planningFolderData)`
  Sets data on a specific planning folder.
  `void`
  `setPlanningFolder5Data(String sessionId, PlanningFolder5SoapDO planningFolderData)`
  Sets data on a specific planning folder.
  `void`
  `setPlanningFolderData(String sessionId, PlanningFolderSoapDO planningFolderData)`
  Sets data on a specific planning folder.
  `void`
  `setPlanningStatusValues(String sessionId, String projectId, PlanningStatusValueSoapDO[] statusValues)`
  Sets status values that is associated with the planning application of a specific project.

  ### Methods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub

  `getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### PlanningAppSoapStub

    public PlanningAppSoapStub(String soapServerUrl)

- ## Method Details

  - ### createPlanningFolder

    public PlanningFolderSoapDO createPlanningFolder(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, String releaseId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Creates a new planning folder
    Specified by:
      `createPlanningFolder` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### createPlanningFolder2

    public PlanningFolder2SoapDO createPlanningFolder2(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, String releaseId, String trackerUnitId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Creates a new planning folder
    Specified by:
      `createPlanningFolder2` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### createPlanningFolder3

    public 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
    Description copied from interface: `IPlanningAppSoap`
    Creates a new planning folder
    Specified by:
      `createPlanningFolder3` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### createPlanningFolder4

    public PlanningFolder4SoapDO createPlanningFolder4(String sessionId, String parentId, PlanningFolder4SoapDO soapDO) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Creates a new planning folder
    Specified by:
      `createPlanningFolder4` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `parentId` - The id of the project under which to create a new top-level planning folder
      `soapDO` - a `PlanningFolder4SoapDO` object
    Returns:
      the planning folder soap object
    Throws:
      `RemoteException`

  - ### createPlanningFolder5

    public 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
    Description copied from interface: `IPlanningAppSoap`
    Creates a new planning folder
    Specified by:
      `createPlanningFolder5` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getPlanningFolderData

    public PlanningFolderSoapDO getPlanningFolderData(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns a data object for a given planning folder
    Specified by:
      `getPlanningFolderData` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Detailed data on the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolder2Data

    public PlanningFolder2SoapDO getPlanningFolder2Data(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns a data object for a given planning folder
    Specified by:
      `getPlanningFolder2Data` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Detailed data on the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolder3Data

    public PlanningFolder3SoapDO getPlanningFolder3Data(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns a data object for a given planning folder
    Specified by:
      `getPlanningFolder3Data` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Detailed data on the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolder4Data

    public PlanningFolder4SoapDO getPlanningFolder4Data(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns a data object for a given planning folder
    Specified by:
      `getPlanningFolder4Data` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Detailed data on the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolder5Data

    public PlanningFolder5SoapDO getPlanningFolder5Data(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns a data object for a given planning folder
    Specified by:
      `getPlanningFolder5Data` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Detailed data on the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolderSummary

    public PlanningFolderSummarySoapDO getPlanningFolderSummary(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
    Specified by:
      `getPlanningFolderSummary` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Statistics for the artifacts in the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolderSummary2

    public PlanningFolderSummary2SoapDO getPlanningFolderSummary2(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
    Specified by:
      `getPlanningFolderSummary2` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Statistics for the artifacts in the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolderSummary3

    public PlanningFolderSummary3SoapDO getPlanningFolderSummary3(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
    Specified by:
      `getPlanningFolderSummary3` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Statistics for the artifacts in the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolderSummary4

    public PlanningFolderSummary4SoapDO getPlanningFolderSummary4(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
    Specified by:
      `getPlanningFolderSummary4` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Statistics for the artifacts in the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolderSummary5

    public PlanningFolderSummary5SoapDO getPlanningFolderSummary5(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the statistics for the artifacts in a given planning folder and all its sub planning folders
    Specified by:
      `getPlanningFolderSummary5` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - PlanningFolder id.
    Returns:
      Statistics for the artifacts in the PlanningFolder.
    Throws:
      `RemoteException`

  - ### getPlanningFolderSummaryList

    public PlanningFolderSummarySoapList getPlanningFolderSummaryList(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project including their statistics
    Specified by:
      `getPlanningFolderSummaryList` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getPlanningFolderSummary2List

    public PlanningFolderSummary2SoapList getPlanningFolderSummary2List(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project including their statistics
    Specified by:
      `getPlanningFolderSummary2List` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getPlanningFolderSummary3List

    public PlanningFolderSummary3SoapList getPlanningFolderSummary3List(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project including their statistics
    Specified by:
      `getPlanningFolderSummary3List` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getPlanningFolderSummary4List

    public PlanningFolderSummary4SoapList getPlanningFolderSummary4List(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project including their statistics
    Specified by:
      `getPlanningFolderSummary4List` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getPlanningFolderSummary5List

    public PlanningFolderSummary5SoapList getPlanningFolderSummary5List(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project including their statistics
    Specified by:
      `getPlanningFolderSummary5List` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### setPlanningFolderData

    public void setPlanningFolderData(String sessionId, PlanningFolderSoapDO planningFolderData) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Sets data on a specific planning folder.
    Specified by:
      `setPlanningFolderData` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderData` - Detailed data on the planning folder to set.
    Throws:
      `RemoteException`

  - ### setPlanningFolder2Data

    public void setPlanningFolder2Data(String sessionId, PlanningFolder2SoapDO planningFolderData) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Sets data on a specific planning folder.
    Specified by:
      `setPlanningFolder2Data` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderData` - Detailed data on the planning folder to set.
    Throws:
      `RemoteException`

  - ### setPlanningFolder3Data

    public void setPlanningFolder3Data(String sessionId, PlanningFolder3SoapDO planningFolderData) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Sets data on a specific planning folder.
    Specified by:
      `setPlanningFolder3Data` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderData` - Detailed data on the planning folder to set.
    Throws:
      `RemoteException`

  - ### setPlanningFolder4Data

    public void setPlanningFolder4Data(String sessionId, PlanningFolder4SoapDO planningFolderData) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Sets data on a specific planning folder.
    Specified by:
      `setPlanningFolder4Data` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderData` - Detailed data on the planning folder to set.
    Throws:
      `RemoteException`

  - ### setPlanningFolder5Data

    public void setPlanningFolder5Data(String sessionId, PlanningFolder5SoapDO planningFolderData) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Sets data on a specific planning folder.
    Specified by:
      `setPlanningFolder5Data` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderData` - Detailed data on the planning folder to set.
    Throws:
      `RemoteException`

  - ### getPlanningFolderList

    public PlanningFolderSoapList getPlanningFolderList(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project.
    Specified by:
      `getPlanningFolderList` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getPlanningFolder2List

    public PlanningFolder2SoapList getPlanningFolder2List(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project.
    Specified by:
      `getPlanningFolder2List` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getPlanningFolder3List

    public PlanningFolder3SoapList getPlanningFolder3List(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project.
    Specified by:
      `getPlanningFolder3List` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getPlanningFolder4List

    public PlanningFolder4SoapList getPlanningFolder4List(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project.
    Specified by:
      `getPlanningFolder4List` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getPlanningFolder5List

    public PlanningFolder5SoapList getPlanningFolder5List(String sessionId, String parentId, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of planning folders within the specified project.
    Specified by:
      `getPlanningFolder5List` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getArtifactListInPlanningFolder

    public ArtifactsInPlanningFolderSoapList getArtifactListInPlanningFolder(String sessionId, String parentId, SoapFilter[] filters, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    /**

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

    Specified by:
      `getArtifactListInPlanningFolder` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `parentId` - parentId
      `filters` - Array of filters to apply (null to return unfiltered list).
      `recursive` - indicates if descendents planning folder artifacts will be included in the result
    Returns:
      List of artifacts contained in the planning folder/its descendents or artifacts not planned yet.
    Throws:
      `RemoteException`

  - ### getArtifactListInPlanningFolder2

    public ArtifactsInPlanningFolder2SoapList getArtifactListInPlanningFolder2(String sessionId, String parentId, SoapFilter[] filters, boolean recursive) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of artifacts contained in a planning folder or its descendants.
    Specified by:
      `getArtifactListInPlanningFolder2` in interface `IPlanningAppSoap`
    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
      `filters` - Array of filters to apply (null to return unfiltered list).
      `recursive` - indicates if descendents planning folder artifacts will be included in the result
    Returns:
      List of artifacts contained in the planning folder/its descendents or artifacts not planned yet.
    Throws:
      `RemoteException`

  - ### getArtifactListInPlanningFolder3

    public ArtifactsInPlanningFolder2SoapList getArtifactListInPlanningFolder3(String sessionId, String parentId, SoapFilter[] filters, boolean recursive, String[] teamId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of artifacts contained in a planning folder or its descendants.
    Specified by:
      `getArtifactListInPlanningFolder3` in interface `IPlanningAppSoap`
    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
      `filters` - Array of filters to apply (null to return unfiltered list).
      `recursive` - indicates if descendents planning folder artifacts will be included in the result
      `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:
      `RemoteException`

  - ### getRankedArtifactList

    public RankedArtifactSoapList getRankedArtifactList(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of artifacts assigned to a planning folder or its descendants with the rank information in the specified planning folder
    Specified by:
      `getRankedArtifactList` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### getRankedArtifactList2

    public RankedArtifact2SoapList getRankedArtifactList2(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Returns the list of artifacts assigned to a planning folder
    Specified by:
      `getRankedArtifactList2` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - this method will return artifacts that are part of this planning folder or its descendants
    Returns:
      List of artifacts contained in the planning folder
    Throws:
      `RemoteException`

  - ### movePlanningFolder

    public PlanningFolderSoapDO movePlanningFolder(String sessionId, String planningFolderId, String destParentId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.
    Specified by:
      `movePlanningFolder` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - planning folder id to move.
      `destParentId` - destination planning folder id
    Returns:
      new planning folder object
    Throws:
      `RemoteException`

  - ### movePlanningFolder2

    public PlanningFolder2SoapDO movePlanningFolder2(String sessionId, String planningFolderId, String destParentId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.
    Specified by:
      `movePlanningFolder2` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - planning folder id to move.
      `destParentId` - destination planning folder id
    Returns:
      new planning folder object
    Throws:
      `RemoteException`

  - ### movePlanningFolder3

    public PlanningFolder3SoapDO movePlanningFolder3(String sessionId, String planningFolderId, String destParentId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.
    Specified by:
      `movePlanningFolder3` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - planning folder id to move.
      `destParentId` - destination planning folder id
    Returns:
      new planning folder object
    Throws:
      `RemoteException`

  - ### movePlanningFolder4

    public PlanningFolder4SoapDO movePlanningFolder4(String sessionId, String planningFolderId, String destParentId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.
    Specified by:
      `movePlanningFolder4` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - planning folder id to move.
      `destParentId` - destination planning folder id
    Returns:
      new planning folder object
    Throws:
      `RemoteException`

  - ### movePlanningFolder5

    public PlanningFolder5SoapDO movePlanningFolder5(String sessionId, String planningFolderId, String destParentId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.
    Specified by:
      `movePlanningFolder5` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `planningFolderId` - planning folder id to move.
      `destParentId` - destination planning folder id
    Returns:
      new planning folder object
    Throws:
      `RemoteException`

  - ### reorderPlanningFolders

    public void reorderPlanningFolders(String sessionId, String parentId, String[] planningFolderIds) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Sets a new order for the planning folders in their parent folder.
    Specified by:
      `reorderPlanningFolders` in interface `IPlanningAppSoap`
    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:
      `RemoteException`

  - ### deletePlanningFolder

    public void deletePlanningFolder(String sessionId, String planningFolderId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Deletes a planning folder with the specified id.
    Specified by:
      `deletePlanningFolder` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - SOAP session id.
      `planningFolderId` - planning folder id to delete.
    Throws:
      `RemoteException`

  - ### setPlanningStatusValues

    public void setPlanningStatusValues(String sessionId, String projectId, PlanningStatusValueSoapDO[] statusValues) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Sets status values that is associated with the planning application of a specific project.
    Specified by:
      `setPlanningStatusValues` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `projectId` - Project for which to set the planning application status values.
      `statusValues` - Array of status values to set
    Throws:
      `RemoteException`
    See Also:
      - `FaultSummary`

  - ### getPlanningStatusValues

    public PlanningStatusValueSoapDO[] getPlanningStatusValues(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `IPlanningAppSoap`
    Gets status values for the planning application of a specific project.
    Specified by:
      `getPlanningStatusValues` in interface `IPlanningAppSoap`
    Parameters:
      `sessionId` - User session id.
      `projectId` - Project for which to set the planning application status values.
    Returns:
      Status values for the planning application.
    Throws:
      `RemoteException`