com.microfocus.silkcentral.webservices.issuemanager

Class IssueManagerService

java.lang.Object

com.microfocus.silkcentral.webservices.issuemanager.IssueManagerService

public class IssueManagerService
extends java.lang.Object

Provides functionality for the issue manager Web Service.

Constructor Summary

Constructors

Constructor and Description
IssueManagerService()

Method Summary

Modifier and Type	Method and Description
int	createIssue(java.lang.String sessionId, int projectId, IssueInformation issue) Creates a new issue in the given project and returns the newly created ID.
boolean	editIssueDescription(java.lang.String sessionId, int projectId, int issueNumber, java.lang.String description, boolean append) Updates the description of a given issue.
java.lang.String[]	getComponentNamesByProduct(java.lang.String sessionId, int projectId, java.lang.String product) Returns an array of component names that are configured for the provided product.
java.lang.String[]	getComponentNamesByProductIssueType(java.lang.String sessionId, int projectId, java.lang.String product, java.lang.String issueType) Returns an array of ComponentNames for the given issue type that are configured for the provided product.
IMComponent[]	getComponents(java.lang.String sessionId, int projectId, java.lang.String product) Returns an array of components that are configured for the provided Issue Manager project and product.
java.lang.String[][]	getGUIObjects(java.lang.String sessionId, int projectId) Returns a list of custom GUI elements.
java.lang.String[]	getInboxes(java.lang.String sessionId, int projectId) Returns the list of names of inboxes that are configured for the provided Issue Manager project.
IssueInformation	getIssueInfo(java.lang.String sessionId, int projectId, int issueNumber, int depth) Returns an information object for the issue with the provided issue number in the provided project.
StatisticEntity[]	getIssueStatistics(java.lang.String sessionId, int projectId) Returns statistics about the number of issues grouped by status and product.
java.lang.String[]	getIssueTypes(java.lang.String sessionId, int projectId) Returns a list of available issue types.
java.lang.String[]	getLOV(java.lang.String sessionId, int projectId, int listId, java.lang.String groupCode) Returns a list of values for a given listId and groupCode.
java.lang.String[][]	getLOVLists(java.lang.String sessionId, int projectId) Returns the list of values that are configured for the provided Issue Manager project.
java.lang.String[]	getPlatformNames(java.lang.String sessionId, int projectId) Returns an array of platform names that are configured for the provided Issue Manager project.
Platform[]	getPlatforms(java.lang.String sessionId, int projectId) Returns an array of platforms that are configured for the provided Issue Manager project.
java.lang.String[]	getPossibleStates(java.lang.String sessionId, int projectId) Returns an array with all states an issue might have in the provided project.
java.lang.String[]	getProductNames(java.lang.String sessionId, int projectId) Returns a list of product names that are configured for the provided Issue Manager project.
Product[]	getProducts(java.lang.String sessionId, int projectId) Returns an array of products that are configured for the provided Issue Manager project.
Project[]	getProjects(java.lang.String sessionId) A Project object has a ProjectId and a ProjectName.
java.lang.String[]	getReleases(java.lang.String sessionId, int projectId, java.lang.String product) Returns an array of ReleaseNames that are configured for the provided product.
java.lang.String[]	getSeverities(java.lang.String sessionId, int projectId, java.lang.String product, java.lang.String issueType) Returns an array of active values that can be used for entering an issue in the given project when the provided IssueType/Product is selected.
java.lang.String	getStatus(java.lang.String sessionId, int projectId, int issueNumber) Returns the status of the issue with the provided issue number in the provided project.
IssueStatusInformation[]	getStatusArray(java.lang.String sessionId, int projectId, int[] issueNumbers) Returns the statuses of the issues with the provided issue numbers in the provided project.
java.lang.String	logonUser(java.lang.String username, java.lang.String plainPwd) Logs on with a given username and password.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueManagerService

public IssueManagerService()

Method Detail

logonUser

public java.lang.String logonUser(java.lang.String username,
                                  java.lang.String plainPwd)
                           throws WSFaultException

Logs on with a given username and password. The returned session identifier can be used in subsequent calls. The session created with the method expires when it is not used for a period of time.
Note: When accessing Silk Central through web-service calls, Micro Focus recommends using a web-service token instead of a session identifier for authenticating. You can generate a web-service token in the Silk Central UI.

Parameters:

username - the login username

plainPwd - the password of the specified username

Returns:

a unique identifier (used as a key) identifying the session created with the method

Throws:

WSFaultException - if logon fails

getProjects

public Project[] getProjects(java.lang.String sessionId)
                      throws WSFaultException

A Project object has a ProjectId and a ProjectName. The ProjectId is used for all further methods for specifying the Issue Manager project you want to work on.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

Returns:

array of initialized Issue Manager projects available for the user, used for generating the sessionId

Throws:

WSFaultException

getIssueTypes

public java.lang.String[] getIssueTypes(java.lang.String sessionId,
                                        int projectId)
                                 throws WSFaultException

Returns a list of available issue types.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project you want to get the issue types from

Returns:

the names of the 3 issue types

Throws:

WSFaultException

getProductNames

public java.lang.String[] getProductNames(java.lang.String sessionId,
                                          int projectId)
                                   throws WSFaultException

Returns a list of product names that are configured for the provided Issue Manager project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project

Returns:

array of ProductNames

Throws:

WSFaultException

getReleases

public java.lang.String[] getReleases(java.lang.String sessionId,
                                      int projectId,
                                      java.lang.String product)
                               throws WSFaultException

Returns an array of ReleaseNames that are configured for the provided product.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project

product - the product name

Returns:

array of ReleaseNames

Throws:

WSFaultException

getPlatformNames

public java.lang.String[] getPlatformNames(java.lang.String sessionId,
                                           int projectId)
                                    throws WSFaultException

Returns an array of platform names that are configured for the provided Issue Manager project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project

Returns:

array of available PlatformNames

Throws:

WSFaultException

getComponentNamesByProductIssueType

public java.lang.String[] getComponentNamesByProductIssueType(java.lang.String sessionId,
                                                              int projectId,
                                                              java.lang.String product,
                                                              java.lang.String issueType)
                                                       throws WSFaultException

Returns an array of ComponentNames for the given issue type that are configured for the provided product. IssueType BUG and ENHANCEMENT will get all Software components. IssueType DOC-ISSUE will get all Documentation components.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project

product - the product name

issueType - name of the issue type

Returns:

array of ComponentNames

Throws:

WSFaultException

getComponentNamesByProduct

public java.lang.String[] getComponentNamesByProduct(java.lang.String sessionId,
                                                     int projectId,
                                                     java.lang.String product)
                                              throws WSFaultException

Returns an array of component names that are configured for the provided product.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project

product - the product name

Returns:

array of ComponentNames

Throws:

WSFaultException

getSeverities

public java.lang.String[] getSeverities(java.lang.String sessionId,
                                        int projectId,
                                        java.lang.String product,
                                        java.lang.String issueType)
                                 throws WSFaultException

Returns an array of active values that can be used for entering an issue in the given project when the provided IssueType/Product is selected. The list of Severities can be grouped by IssueType or Product. If the list is grouped by IssueType the parameter issueType has to be provided and the product parameter can be empty. If the list is grouped by product, issueType can be empty and the product has to be selected.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project

product - the product name

issueType - the issue type for which the severities are to be returned

Returns:

array of severities

Throws:

WSFaultException

getProducts

public Product[] getProducts(java.lang.String sessionId,
                             int projectId)
                      throws WSFaultException

Returns an array of products that are configured for the provided Issue Manager project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

Returns:

array of Products

Throws:

WSFaultException

getPlatforms

public Platform[] getPlatforms(java.lang.String sessionId,
                               int projectId)
                        throws WSFaultException

Returns an array of platforms that are configured for the provided Issue Manager project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

Returns:

array of Platforms

Throws:

WSFaultException

getComponents

public IMComponent[] getComponents(java.lang.String sessionId,
                                   int projectId,
                                   java.lang.String product)
                            throws WSFaultException

Returns an array of components that are configured for the provided Issue Manager project and product.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

product -

Returns:

array of Components

Throws:

WSFaultException

getInboxes

public java.lang.String[] getInboxes(java.lang.String sessionId,
                                     int projectId)
                              throws WSFaultException

Returns the list of names of inboxes that are configured for the provided Issue Manager project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

Returns:

names of inboxes

Throws:

WSFaultException

getLOVLists

public java.lang.String[][] getLOVLists(java.lang.String sessionId,
                                        int projectId)
                                 throws WSFaultException

Returns the list of values that are configured for the provided Issue Manager project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

Returns:

list of values that are configured for the provided Issue Manager project

Throws:

WSFaultException

getLOV

public java.lang.String[] getLOV(java.lang.String sessionId,
                                 int projectId,
                                 int listId,
                                 java.lang.String groupCode)
                          throws WSFaultException

Returns a list of values for a given listId and groupCode.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

listId -

groupCode -

Returns:

Throws:

WSFaultException

createIssue

public int createIssue(java.lang.String sessionId,
                       int projectId,
                       IssueInformation issue)
                throws WSFaultException

Creates a new issue in the given project and returns the newly created ID.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project where to save the

issue - a class containing the issue information

Returns:

the issue number of the newly generated issue

Throws:

WSFaultException

getStatus

public java.lang.String getStatus(java.lang.String sessionId,
                                  int projectId,
                                  int issueNumber)
                           throws WSFaultException

Returns the status of the issue with the provided issue number in the provided project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

issueNumber -

Returns:

the status of the issue

Throws:

WSFaultException

getStatusArray

public IssueStatusInformation[] getStatusArray(java.lang.String sessionId,
                                               int projectId,
                                               int[] issueNumbers)
                                        throws WSFaultException

Returns the statuses of the issues with the provided issue numbers in the provided project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

issueNumbers -

Returns:

the statuses of the issues

Throws:

WSFaultException

getPossibleStates

public java.lang.String[] getPossibleStates(java.lang.String sessionId,
                                            int projectId)
                                     throws WSFaultException

Returns an array with all states an issue might have in the provided project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

Returns:

array of all states an issue might have in the provided project

Throws:

WSFaultException

getIssueInfo

public IssueInformation getIssueInfo(java.lang.String sessionId,
                                     int projectId,
                                     int issueNumber,
                                     int depth)
                              throws WSFaultException

Returns an information object for the issue with the provided issue number in the provided project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

issueNumber -

depth - 0 = normal; 1 = including description; 2 = including history

Returns:

information object for the issue

Throws:

WSFaultException

getIssueStatistics

public StatisticEntity[] getIssueStatistics(java.lang.String sessionId,
                                            int projectId)
                                     throws WSFaultException

Returns statistics about the number of issues grouped by status and product.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

Returns:

statistics array

Throws:

WSFaultException

editIssueDescription

public boolean editIssueDescription(java.lang.String sessionId,
                                    int projectId,
                                    int issueNumber,
                                    java.lang.String description,
                                    boolean append)
                             throws WSFaultException

Updates the description of a given issue.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

issueNumber -

description -

append - true to append the specified description to the existing one; false to replace the description

Returns:

true if update was successful

Throws:

WSFaultException

getGUIObjects

public java.lang.String[][] getGUIObjects(java.lang.String sessionId,
                                          int projectId)
                                   throws WSFaultException

Returns a list of custom GUI elements.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId -

Returns:

Throws:

java.rmi.RemoteException

java.sql.SQLException

WSFaultException