Class PlanningAppSoapStub
java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.planning.PlanningAppSoapStub
- All Implemented Interfaces:
IPlanningAppSoap
-
Field Summary
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreatePlanningFolder
(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, String releaseId) Creates a new planning foldercreatePlanningFolder2
(String sessionId, String parentId, String title, String description, Date startDate, Date endDate, String status, int capacity, String releaseId, String trackerUnitId) Creates a new planning foldercreatePlanningFolder3
(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 foldercreatePlanningFolder4
(String sessionId, String parentId, PlanningFolder4SoapDO soapDO) Creates a new planning foldercreatePlanningFolder5
(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) /**getArtifactListInPlanningFolder2
(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) Returns a data object for a given planning foldergetPlanningFolder2List
(String sessionId, String parentId, boolean recursive) Returns the list of planning folders within the specified project.getPlanningFolder3Data
(String sessionId, String planningFolderId) Returns a data object for a given planning foldergetPlanningFolder3List
(String sessionId, String parentId, boolean recursive) Returns the list of planning folders within the specified project.getPlanningFolder4Data
(String sessionId, String planningFolderId) Returns a data object for a given planning foldergetPlanningFolder4List
(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) Returns a data object for a given planning foldergetPlanningFolderList
(String sessionId, String parentId, boolean recursive) Returns the list of planning folders within the specified project.getPlanningFolderSummary
(String sessionId, String planningFolderId) Returns the statistics for the artifacts in a given planning folder and all its sub planning foldersgetPlanningFolderSummary2
(String sessionId, String planningFolderId) Returns the statistics for the artifacts in a given planning folder and all its sub planning foldersgetPlanningFolderSummary2List
(String sessionId, String parentId, boolean recursive) Returns the list of planning folders within the specified project including their statisticsgetPlanningFolderSummary3
(String sessionId, String planningFolderId) Returns the statistics for the artifacts in a given planning folder and all its sub planning foldersgetPlanningFolderSummary3List
(String sessionId, String parentId, boolean recursive) Returns the list of planning folders within the specified project including their statisticsgetPlanningFolderSummary4
(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) Returns the list of planning folders within the specified project including their statisticsgetPlanningStatusValues
(String sessionId, String projectId) Gets status values for the planning application of a specific project.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 foldergetRankedArtifactList2
(String sessionId, String planningFolderId) Returns the list of artifacts assigned to a planning foldermovePlanningFolder
(String sessionId, String planningFolderId, String destParentId) Moves a Planning Folder including its sub folders and contents.movePlanningFolder2
(String sessionId, String planningFolderId, String destParentId) Moves a Planning Folder including its sub folders and contents.movePlanningFolder3
(String sessionId, String planningFolderId, String destParentId) Moves a Planning Folder including its sub folders and contents.movePlanningFolder4
(String sessionId, String planningFolderId, String destParentId) Moves a Planning Folder including its sub folders and contents.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
-
Constructor Details
-
PlanningAppSoapStub
-
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- Parameters:
sessionId
- User session id.parentId
- parentIdfilters
- 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:
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
-
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 interfaceIPlanningAppSoap
- Parameters:
sessionId
- User session id.parentId
- if parentId is a planning folder id, this method will return artifacts that are part of this planning folderfilters
- 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:
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
-
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 interfaceIPlanningAppSoap
- Parameters:
sessionId
- User session id.parentId
- if parentId is a planning folder id, this method will return artifacts that are part of this planning folderfilters
- Array of filters to apply (null to return unfiltered list).recursive
- indicates if descendents planning folder artifacts will be included in the resultteamId
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
-
deletePlanningFolder
Description copied from interface:IPlanningAppSoap
Deletes a planning folder with the specified id.- Specified by:
deletePlanningFolder
in interfaceIPlanningAppSoap
- 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
-
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 interfaceIPlanningAppSoap
- 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
- See Also:
-
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 interfaceIPlanningAppSoap
- 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
-