Interface IPlanningAppSoap
- All Known Implementing Classes:
PlanningAppSoap
,PlanningAppSoapMockStub
,PlanningAppSoapStub
public interface IPlanningAppSoap
-
Method Summary
Modifier and TypeMethodDescriptioncreatePlanningFolder
(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, String releaseId) Deprecated.in favor of createPlanningFolder4createPlanningFolder2
(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, String releaseId, String trackerUnitId) Deprecated.in favor of createPlanningFolder4createPlanningFolder3
(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, int pointsCapacity, String releaseId, String trackerUnitId) Deprecated.in favor of createPlanningFolder4createPlanningFolder4
(String sessionId, String parentId, PlanningFolder4SoapDO soapDO) Deprecated.in favor of createPlanningFolder5createPlanningFolder5
(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 foldervoid
deletePlanningFolder
(String sessionId, String planningFolderId) Deletes a planning folder with the specified id.getArtifactListInPlanningFolder
(String sessionId, String parentId, SoapFilter[] filters, boolean recursive) Deprecated.in favor of getArtifactListInPlanningFolder2getArtifactListInPlanningFolder2
(String sessionId, String parentId, SoapFilter[] filters, boolean recursive) Returns the list of artifacts contained in a planning folder or its descendants.getArtifactListInPlanningFolder3
(String sessionId, String parentId, SoapFilter[] filters, boolean recursive, String[] teamId) Returns the list of artifacts contained in a planning folder or its descendants.getPlanningFolder2Data
(String sessionId, String planningFolderId) Deprecated.in favor of getPlanningFolder4Data.getPlanningFolder2List
(String sessionId, String parentId, boolean recursive) Deprecated.in favor of getPlanningFolder4ListgetPlanningFolder3Data
(String sessionId, String planningFolderId) Deprecated.in favor of getPlanningFolder4Data.getPlanningFolder3List
(String sessionId, String parentId, boolean recursive) Deprecated.in favor of getPlanningFolder4ListgetPlanningFolder4Data
(String sessionId, String planningFolderId) Deprecated.in favor of getPlanningFolder5Data.getPlanningFolder4List
(String sessionId, String parentId, boolean recursive) Returns the list of planning folders within the specified project.getPlanningFolder5Data
(String sessionId, String planningFolderId) Returns a data object for a given planning foldergetPlanningFolder5List
(String sessionId, String parentId, boolean recursive) Returns the list of planning folders within the specified project.getPlanningFolderData
(String sessionId, String planningFolderId) Deprecated.in favor of getPlanningFolder4Data.getPlanningFolderList
(String sessionId, String parentId, boolean recursive) Deprecated.in favor of getPlanningFolder4ListgetPlanningFolderSummary
(String sessionId, String planningFolderId) Deprecated.in favor of getPlanningFolderSummary4getPlanningFolderSummary2
(String sessionId, String planningFolderId) Deprecated.in favor of getPlanningFolderSummary4getPlanningFolderSummary2List
(String sessionId, String parentId, boolean recursive) Deprecated.in favor of getPlanningFolderSummary4ListgetPlanningFolderSummary3
(String sessionId, String planningFolderId) Deprecated.in favor of getPlanningFolderSummary4getPlanningFolderSummary3List
(String sessionId, String parentId, boolean recursive) Deprecated.in favor of getPlanningFolderSummary4ListgetPlanningFolderSummary4
(String sessionId, String planningFolderId) Returns the statistics for the artifacts in a given planning folder and all its sub planning foldersgetPlanningFolderSummary4List
(String sessionId, String parentId, boolean recursive) Returns the list of planning folders within the specified project including their statisticsgetPlanningFolderSummary5
(String sessionId, String planningFolderId) Returns the statistics for the artifacts in a given planning folder and all its sub planning foldersgetPlanningFolderSummary5List
(String sessionId, String parentId, boolean recursive) Returns the list of planning folders within the specified project including their statisticsgetPlanningFolderSummaryList
(String sessionId, String parentId, boolean recursive) Deprecated.in favor of getPlanningFolderSummary4ListgetPlanningStatusValues
(String sessionId, String projectId) Gets status values for the planning application of a specific project.getRankedArtifactList
(String sessionId, String planningFolderId) Deprecated.in favor of getRankedArtifactList2getRankedArtifactList2
(String sessionId, String planningFolderId) Returns the list of artifacts assigned to a planning foldermovePlanningFolder
(String sessionId, String planningFolderId, String destParentId) Deprecated.in favor of movePlanningFolder5movePlanningFolder2
(String sessionId, String planningFolderId, String destParentId) Deprecated.in favor of movePlanningFolder5movePlanningFolder3
(String sessionId, String planningFolderId, String destParentId) Deprecated.in favor of movePlanningFolder5movePlanningFolder4
(String sessionId, String planningFolderId, String destParentId) Deprecated.in favor of movePlanningFolder5movePlanningFolder5
(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) Deprecated.in favor of setPlanningFolder4Datavoid
setPlanningFolder3Data
(String sessionId, PlanningFolder3SoapDO planningFolderData) Deprecated.in favor of setPlanningFolder4Datavoid
setPlanningFolder4Data
(String sessionId, PlanningFolder4SoapDO planningFolderData) Deprecated.in favor of setPlanningFolder5Datavoid
setPlanningFolder5Data
(String sessionId, PlanningFolder5SoapDO planningFolderData) Sets data on a specific planning folder.void
setPlanningFolderData
(String sessionId, PlanningFolderSoapDO planningFolderData) Deprecated.in favor of setPlanningFolder4Datavoid
setPlanningStatusValues
(String sessionId, String projectId, PlanningStatusValueSoapDO[] statusValues) Sets status values that is associated with the planning application of a specific project.
-
Method Details
-
createPlanningFolder
@Deprecated 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 createPlanningFolder4Creates a new planning folder- Parameters:
sessionId
- User session id.parentId
- The id of the project under which to create a new top-level planning foldertitle
- The title of the new planning folderdescription
- The description of the new planning folderstartDate
- The start date of the new planning folderendDate
- The end date of the new planning folderstatus
- The status of the new planning foldercapacity
- The capacity of the new planning folderreleaseId
- 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 parentIllegalArgumentFault
- if invalid argument value was supplied.RemoteException
- Since:
- 5.3
-
createPlanningFolder2
@Deprecated 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 createPlanningFolder4Creates a new planning folder- Parameters:
sessionId
- User session id.parentId
- The id of the project under which to create a new top-level planning foldertitle
- The title of the new planning folderdescription
- The description of the new planning folderstartDate
- The start date of the new planning folderendDate
- The end date of the new planning folderstatus
- The status of the new planning foldercapacity
- The capacity of the new planning folderreleaseId
- The release which is associated with the new planning foldertrackerUnitId
- 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 parentIllegalArgumentFault
- if invalid argument value was supplied.RemoteException
- Since:
- 6.2
-
createPlanningFolder3
@Deprecated 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 createPlanningFolder4Creates a new planning folder- Parameters:
sessionId
- User session id.parentId
- The id of the project under which to create a new top-level planning foldertitle
- The title of the new planning folderdescription
- The description of the new planning folderstartDate
- The start date of the new planning folderendDate
- The end date of the new planning folderstatus
- The status of the new planning foldercapacity
- The efforts capacity of the new planning folderpointsCapacity
- The points capacity of the new planning folderreleaseId
- The release which is associated with the new planning foldertrackerUnitId
- 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 parentIllegalArgumentFault
- if invalid argument value was supplied.RemoteException
- Since:
- 7.1
-
createPlanningFolder4
@Deprecated PlanningFolder4SoapDO createPlanningFolder4(String sessionId, String parentId, PlanningFolder4SoapDO soapDO) throws RemoteException Deprecated.in favor of createPlanningFolder5Creates a new planning folder- Parameters:
sessionId
- User session id.parentId
- The id of the project under which to create a new top-level planning foldersoapDO
- aPlanningFolder4SoapDO
object- 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 parentIllegalArgumentFault
- if invalid argument value was supplied.RemoteException
- Since:
- 7.2
-
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 foldertype
- The type of the new planning foldertitle
- The title of the new planning folderdescription
- The description of the new planning folderstartDate
- The start date of the new planning folderendDate
- The end date of the new planning folderstatus
- The status of the new planning foldercapacity
- The efforts capacity of the new planning folderpointsCapacity
- The points capacity of the new planning folderreleaseId
- The release which is associated with the new planning foldertrackerUnitId
- The tracker unit idburndownViewMode
- 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 parentIllegalArgumentFault
- if invalid argument value was supplied.RemoteException
- Since:
- 8.2
-
getPlanningFolderData
@Deprecated PlanningFolderSoapDO getPlanningFolderData(String sessionId, String planningFolderId) throws RemoteException Deprecated.in favor of getPlanningFolder4Data.Returns a data object for a given planning folder- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Detailed data on the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 5.3
-
getPlanningFolder2Data
@Deprecated PlanningFolder2SoapDO getPlanningFolder2Data(String sessionId, String planningFolderId) throws RemoteException Deprecated.in favor of getPlanningFolder4Data.Returns a data object for a given planning folder- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Detailed data on the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 6.2
-
getPlanningFolder3Data
@Deprecated PlanningFolder3SoapDO getPlanningFolder3Data(String sessionId, String planningFolderId) throws RemoteException Deprecated.in favor of getPlanningFolder4Data.Returns a data object for a given planning folder- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Detailed data on the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 7.1
-
getPlanningFolder4Data
@Deprecated PlanningFolder4SoapDO getPlanningFolder4Data(String sessionId, String planningFolderId) throws RemoteException Deprecated.in favor of getPlanningFolder5Data.Returns a data object for a given planning folder- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Detailed data on the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 7.2
-
getPlanningFolder5Data
PlanningFolder5SoapDO getPlanningFolder5Data(String sessionId, String planningFolderId) throws RemoteException Returns a data object for a given planning folder- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Detailed data on the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 8.2
-
getPlanningFolderSummary
@Deprecated PlanningFolderSummarySoapDO getPlanningFolderSummary(String sessionId, String planningFolderId) throws RemoteException Deprecated.in favor of getPlanningFolderSummary4Returns the statistics for the artifacts in a given planning folder and all its sub planning folders- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Statistics for the artifacts in the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 5.3
-
getPlanningFolderSummary2
@Deprecated PlanningFolderSummary2SoapDO getPlanningFolderSummary2(String sessionId, String planningFolderId) throws RemoteException Deprecated.in favor of getPlanningFolderSummary4Returns the statistics for the artifacts in a given planning folder and all its sub planning folders- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Statistics for the artifacts in the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 6.2
-
getPlanningFolderSummary3
@Deprecated PlanningFolderSummary3SoapDO getPlanningFolderSummary3(String sessionId, String planningFolderId) throws RemoteException Deprecated.in favor of getPlanningFolderSummary4Returns the statistics for the artifacts in a given planning folder and all its sub planning folders- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Statistics for the artifacts in the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 7.1
-
getPlanningFolderSummary4
PlanningFolderSummary4SoapDO getPlanningFolderSummary4(String sessionId, String planningFolderId) throws RemoteException Returns the statistics for the artifacts in a given planning folder and all its sub planning folders- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Statistics for the artifacts in the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 7.2
-
getPlanningFolderSummary5
PlanningFolderSummary5SoapDO getPlanningFolderSummary5(String sessionId, String planningFolderId) throws RemoteException Returns the statistics for the artifacts in a given planning folder and all its sub planning folders- Parameters:
sessionId
- User session id.planningFolderId
- PlanningFolder id.- Returns:
- Statistics for the artifacts in the PlanningFolder.
- 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 argument is invalid.RemoteException
- Since:
- 8.2
-
getPlanningFolderSummaryList
@Deprecated PlanningFolderSummarySoapList getPlanningFolderSummaryList(String sessionId, String parentId, boolean recursive) throws RemoteException Deprecated.in favor of getPlanningFolderSummary4ListReturns 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
@Deprecated PlanningFolderSummary2SoapList getPlanningFolderSummary2List(String sessionId, String parentId, boolean recursive) throws RemoteException Deprecated.in favor of getPlanningFolderSummary4ListReturns 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
@Deprecated PlanningFolderSummary3SoapList getPlanningFolderSummary3List(String sessionId, String parentId, boolean recursive) throws RemoteException Deprecated.in favor of getPlanningFolderSummary4ListReturns 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
-
setPlanningFolderData
@Deprecated void setPlanningFolderData(String sessionId, PlanningFolderSoapDO planningFolderData) throws RemoteException Deprecated.in favor of setPlanningFolder4DataSets data on a specific planning folder.- Parameters:
sessionId
- User session id.planningFolderData
- Detailed data on the planning folder to set.- 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 data is specified.VersionMismatchFault
- when the data object is not up to date any more.RemoteException
- Since:
- 5.3
-
setPlanningFolder2Data
@Deprecated void setPlanningFolder2Data(String sessionId, PlanningFolder2SoapDO planningFolderData) throws RemoteException Deprecated.in favor of setPlanningFolder4DataSets data on a specific planning folder.- Parameters:
sessionId
- User session id.planningFolderData
- Detailed data on the planning folder to set.- 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 data is specified.VersionMismatchFault
- when the data object is not up to date any more.RemoteException
- Since:
- 6.2
-
setPlanningFolder3Data
@Deprecated void setPlanningFolder3Data(String sessionId, PlanningFolder3SoapDO planningFolderData) throws RemoteException Deprecated.in favor of setPlanningFolder4DataSets data on a specific planning folder.- Parameters:
sessionId
- User session id.planningFolderData
- Detailed data on the planning folder to set.- 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 data is specified.VersionMismatchFault
- when the data object is not up to date any more.RemoteException
- Since:
- 7.1
-
setPlanningFolder4Data
@Deprecated void setPlanningFolder4Data(String sessionId, PlanningFolder4SoapDO planningFolderData) throws RemoteException Deprecated.in favor of setPlanningFolder5DataSets data on a specific planning folder.- Parameters:
sessionId
- User session id.planningFolderData
- Detailed data on the planning folder to set.- 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 data is specified.VersionMismatchFault
- when the data object is not up to date any more.RemoteException
- Since:
- 7.2
-
setPlanningFolder5Data
void setPlanningFolder5Data(String sessionId, PlanningFolder5SoapDO planningFolderData) throws RemoteException Sets data on a specific planning folder.- Parameters:
sessionId
- User session id.planningFolderData
- Detailed data on the planning folder to set.- 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 data is specified.VersionMismatchFault
- when the data object is not up to date any more.RemoteException
- Since:
- 8.2
-
getPlanningFolderList
@Deprecated PlanningFolderSoapList getPlanningFolderList(String sessionId, String parentId, boolean recursive) throws RemoteException Deprecated.in favor of getPlanningFolder4ListReturns 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
@Deprecated PlanningFolder2SoapList getPlanningFolder2List(String sessionId, String parentId, boolean recursive) throws RemoteException Deprecated.in favor of getPlanningFolder4ListReturns 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
@Deprecated PlanningFolder3SoapList getPlanningFolder3List(String sessionId, String parentId, boolean recursive) throws RemoteException Deprecated.in favor of getPlanningFolder4ListReturns 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
@Deprecated 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
- parentIdrecursive
- indicates if descendents planning folder artifacts will be included in the resultfilters
- 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 folderrecursive
- indicates if descendents planning folder artifacts will be included in the resultfilters
- 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 folderrecursive
- indicates if descendents planning folder artifacts will be included in the resultfilters
- 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
@Deprecated RankedArtifactSoapList getRankedArtifactList(String sessionId, String planningFolderId) throws RemoteException Deprecated.in favor of getRankedArtifactList2Returns 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
-
getRankedArtifactList2
RankedArtifact2SoapList getRankedArtifactList2(String sessionId, String planningFolderId) throws RemoteException Returns the list of artifacts assigned to a planning folder- 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:
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
-
movePlanningFolder
@Deprecated PlanningFolderSoapDO movePlanningFolder(String sessionId, String planningFolderId, String destParentId) throws RemoteException Deprecated.in favor of movePlanningFolder5Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.- Parameters:
sessionId
- User session id.planningFolderId
- planning folder id to move.destParentId
- destination planning folder id- Returns:
- new planning folder object
- Throws:
InvalidSessionFault
- when sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when specified object is invalid.SystemFault
- when an unexpected system error occurs.IllegalArgumentFault
- if invalid argument value is passed.PlanningFolderRuleViolationFault
- if the operation would cause planning folder violationRemoteException
- Since:
- 5.3
-
movePlanningFolder2
@Deprecated PlanningFolder2SoapDO movePlanningFolder2(String sessionId, String planningFolderId, String destParentId) throws RemoteException Deprecated.in favor of movePlanningFolder5Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.- Parameters:
sessionId
- User session id.planningFolderId
- planning folder id to move.destParentId
- destination planning folder id- Returns:
- new planning folder object
- Throws:
InvalidSessionFault
- when sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when specified object is invalid.SystemFault
- when an unexpected system error occurs.IllegalArgumentFault
- if invalid argument value is passed.PlanningFolderRuleViolationFault
- if the operation would cause planning folder violationRemoteException
- Since:
- 6.2
-
movePlanningFolder3
@Deprecated PlanningFolder3SoapDO movePlanningFolder3(String sessionId, String planningFolderId, String destParentId) throws RemoteException Deprecated.in favor of movePlanningFolder5Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.- Parameters:
sessionId
- User session id.planningFolderId
- planning folder id to move.destParentId
- destination planning folder id- Returns:
- new planning folder object
- Throws:
InvalidSessionFault
- when sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when specified object is invalid.SystemFault
- when an unexpected system error occurs.IllegalArgumentFault
- if invalid argument value is passed.PlanningFolderRuleViolationFault
- if the operation would cause planning folder violationRemoteException
- Since:
- 7.1
-
movePlanningFolder4
@Deprecated PlanningFolder4SoapDO movePlanningFolder4(String sessionId, String planningFolderId, String destParentId) throws RemoteException Deprecated.in favor of movePlanningFolder5Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.- Parameters:
sessionId
- User session id.planningFolderId
- planning folder id to move.destParentId
- destination planning folder id- Returns:
- new planning folder object
- Throws:
InvalidSessionFault
- when sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when specified object is invalid.SystemFault
- when an unexpected system error occurs.IllegalArgumentFault
- if invalid argument value is passed.PlanningFolderRuleViolationFault
- if the operation would cause planning folder violationRemoteException
- Since:
- 7.2
-
movePlanningFolder5
PlanningFolder5SoapDO movePlanningFolder5(String sessionId, String planningFolderId, String destParentId) throws RemoteException Moves a Planning Folder including its sub folders and contents. Fails if not everything can be moved.- Parameters:
sessionId
- User session id.planningFolderId
- planning folder id to move.destParentId
- destination planning folder id- Returns:
- new planning folder object
- Throws:
InvalidSessionFault
- when sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when specified object is invalid.SystemFault
- when an unexpected system error occurs.IllegalArgumentFault
- if invalid argument value is passed.PlanningFolderRuleViolationFault
- if the operation would cause planning folder violationRemoteException
- Since:
- 8.2
-
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 folderplanningFolderIds
- 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
-
deletePlanningFolder
Deletes a planning folder with the specified id.- Parameters:
sessionId
- SOAP session id.planningFolderId
- planning folder id to delete.- Throws:
InvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalidSystemFault
- when an unexpected system error occurs.IllegalArgumentFault
- when one or more of the parameters are invalid.VersionMismatchFault
- when an artifact associated to the planning folderPlanningFolderRuleViolationFault
- if the operation would cause planning folder violationRemoteException
- Since:
- 5.3
-
setPlanningStatusValues
void setPlanningStatusValues(String sessionId, String projectId, PlanningStatusValueSoapDO[] statusValues) throws RemoteException Sets status values that is associated with the planning application of a specific project.- Parameters:
sessionId
- User session id.projectId
- Project for which to set the planning application status values.statusValues
- Array of status values to set- Throws:
NoSuchObjectFault
- when failed to get status field for the given projectInvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.VersionMismatchFault
- if the values have been updated since this status field was fetchedIllegalArgumentFault
- if the arguments are incorrectly specified.InvalidOperationFault
- if the operation is not allowed.SystemFault
- when an unexpected system error occurs.DependencyViolationFault
- if changing a status violates artifact dependencyRemoteException
- Since:
- 5.4
- See Also:
-
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 projectInvalidSessionFault
- 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
-