com.microfocus.silkcentral.webservices.requirements

Class RequirementsService

java.lang.Object

com.microfocus.silkcentral.webservices.requirements.RequirementsService

public class RequirementsService
extends java.lang.Object

Provides the functionality for the Requirements Web Service.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_OBSOLETE Boolean value that defines if a requirement is marked as obsolete or not.
static java.lang.String	PROPERTY_PRIORITY Integer value that sets the current priority state of a requirement: 0 not set 1 Low 2 Medium 3 High 4 Critical
static java.lang.String	PROPERTY_REVIEWED Boolean value that defines if a requirement is reviewed or not.
static java.lang.String	PROPERTY_RISK Integer value that sets the current risk state of a requirement: 0 not set 1 Low 2 Medium 3 High 4 Critical
static java.lang.String	PROPERTY_VERSION Used for external requirement management tools to set their requirement version here.

Constructor Summary

Constructors

Constructor and Description
RequirementsService()

Method Summary

Modifier and Type	Method and Description
void	assignTest(java.lang.String sessionId, int requirementId, int testId) This method assigns the test with the provided test ID to the requirement with the provided requirement ID.
void	deleteCustomProperty(java.lang.String sessionId, int propertyId)
void	deleteRequirement(java.lang.String sessionId, int requirementId, boolean recursiv) This method deletes the provided requirement.
Test[]	getAssignedTests(java.lang.String sessionId, int requirementId) This method returns all assigned tests for the provided requirement.
CustomProperty[]	getCustomProperties(java.lang.String sessionId, int projectId) Retrieves all CustomProperty objects for a project.
CustomProperty	getCustomProperty(java.lang.String sessionId, int propertyId) Retrieves a CustomProperty object for the given propertyId.
Project	getProject(java.lang.String sessionId, int projectId) This method returns the project for the provided projectId.
Project[]	getProjects(java.lang.String sessionId) This method returns all existing and available projects.
PropertyValue	getProperty(java.lang.String sessionId, int requirementId, java.lang.String propertyId) This method returns the property value for a provided property ID and requirement.
java.lang.String[]	getPropertyIds(java.lang.String sessionId, int projectId) This method returns the property IDs of all defined properties for the provided project.
PropertyMetaInfo	getPropertyInfo(java.lang.String sessionId, int projectId, java.lang.String propertyId) This method returns the meta information for a property of a project.
Requirement	getRequirement(java.lang.String sessionId, int requirementId) This method returns the requirement for the provided requirement ID.
Requirement[]	getRequirementChildren(java.lang.String sessionId, int projectId, int requirementId) This method returns all child requirements of the provided requirement.
Requirement[]	getTopLevelRequirements(java.lang.String sessionId, int projectId) This method returns all top level requirements of the provided project.
void	insertCustomProperty(java.lang.String sessionId, CustomProperty newProperty)
java.lang.String	logonUser(java.lang.String username, java.lang.String plainPwd) Logs on with a given username and password.
void	setRequirementFlagStatus(java.lang.String sessionId, int requirementId, int flagType, java.lang.Boolean includeChildren, java.lang.String comments) This method sets or clears a flag for a requirement and optionally its child requirements.
void	unassignTest(java.lang.String sessionId, int requirementId, int testId) This method unassigns the test with the provided test ID from the requirement with the provided requirement ID.
void	updateProperties(java.lang.String sessionId, int requirementId, PropertyValue[] properties) This method updates all provided property values.
java.lang.String	updateProperty(java.lang.String sessionId, int requirementId, PropertyValue property) This method updates the property value.
int	updateRequirement(java.lang.String sessionId, int projectId, Requirement requirement, int prevSiblingId) This method creates or updates the provided requirement.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_RISK

public static final java.lang.String PROPERTY_RISK

Integer value that sets the current risk state of a requirement:
0 not set
1 Low
2 Medium
3 High
4 Critical

See Also:

Constant Field Values

PROPERTY_REVIEWED

public static final java.lang.String PROPERTY_REVIEWED

Boolean value that defines if a requirement is reviewed or not.

See Also:

Constant Field Values

PROPERTY_PRIORITY

public static final java.lang.String PROPERTY_PRIORITY

Integer value that sets the current priority state of a requirement:
0 not set
1 Low
2 Medium
3 High
4 Critical

See Also:

Constant Field Values

PROPERTY_OBSOLETE

public static final java.lang.String PROPERTY_OBSOLETE

Boolean value that defines if a requirement is marked as obsolete or not.

See Also:

Constant Field Values

PROPERTY_VERSION

public static final java.lang.String PROPERTY_VERSION

Used for external requirement management tools to set their requirement version here.

See Also:

Constant Field Values

Constructor Detail

RequirementsService

public RequirementsService()

Method Detail

logonUser

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

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

getProject

public Project getProject(java.lang.String sessionId,
                          int projectId)
                   throws WSFaultException

This method returns the project for the provided projectId.

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 - ID of the project

Returns:

project for provided project ID

Throws:

WSFaultException

getProjects

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

This method returns all existing and available projects.

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 all existing projects

Throws:

WSFaultException

getTopLevelRequirements

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

This method returns all top level requirements of 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 - ID of the project

Returns:

all top level requirements of provided project

Throws:

WSFaultException

getRequirementChildren

public Requirement[] getRequirementChildren(java.lang.String sessionId,
                                            int projectId,
                                            int requirementId)
                                     throws WSFaultException

This method returns all child requirements of the provided requirement.

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 - ID of the project

requirementId - ID of the requirement from which you want to get the children

Returns:

requirement children of the requirement with the provided requirement ID

Throws:

WSFaultException

getRequirement

public Requirement getRequirement(java.lang.String sessionId,
                                  int requirementId)
                           throws WSFaultException

This method returns the requirement for the provided requirement 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)

requirementId - ID of the requirement that is to be returned

Returns:

requirement with the ID that matches the provided requirement ID

Throws:

WSFaultException

updateRequirement

public int updateRequirement(java.lang.String sessionId,
                             int projectId,
                             Requirement requirement,
                             int prevSiblingId)
                      throws WSFaultException

This method creates or updates the provided requirement. If the requirement must be created, the new generated requirement ID is returned. If locking must be performed, the requirement object itself handles it. To create a new requirement, simply supply a requirement object with an empty string for requirementId.

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 - ID of the project where to update the requirement

requirement - the requirement object of the requirement that is to be updated

prevSiblingId - (optional) if supported, the ID of the previous sibling requirement, -1 if not supported or this is the first sibling

Returns:

ID of the requirement

Throws:

WSFaultException

deleteRequirement

public void deleteRequirement(java.lang.String sessionId,
                              int requirementId,
                              boolean recursiv)
                       throws WSFaultException

This method deletes the provided requirement. If the requirement has children, they are only deleted if recursive is true, otherwise the method fails and the requirement itself is not deleted.

Parameters:

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

requirementId - ID of the requirement that is to be deleted

recursiv - boolean, that determines if existing children are to be deleted (this flag is not supported in the requirements service. The requirement and all its children are always deleted.)

Throws:

WSFaultException

getPropertyIds

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

This method returns the property IDs of all defined properties for 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 - ID of the project

Returns:

string array of all property IDs for the provided project ID

Throws:

WSFaultException

getPropertyInfo

public PropertyMetaInfo getPropertyInfo(java.lang.String sessionId,
                                        int projectId,
                                        java.lang.String propertyId)
                                 throws WSFaultException

This method returns the meta information for a property of a 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 - ID of the project

propertyId - ID of the property that is to be retrieved

Returns:

property meta info for a specific property (string Id from getPropertyIds() )

Throws:

WSFaultException

getProperty

public PropertyValue getProperty(java.lang.String sessionId,
                                 int requirementId,
                                 java.lang.String propertyId)
                          throws WSFaultException

This method returns the property value for a provided property ID and requirement.

Parameters:

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

requirementId - ID of the requirement

propertyId - ID of the property that is to be retrieved

Returns:

property value of a property of the requirement with the provided property and requirement ID

Throws:

WSFaultException

updateProperty

public java.lang.String updateProperty(java.lang.String sessionId,
                                       int requirementId,
                                       PropertyValue property)
                                throws WSFaultException

This method updates the property value. If some sort of locking has to be done, the property objects perform it within themselves.

Parameters:

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

requirementId - ID of the requirement that is to be updated

property - property that is to be updated

Returns:

property ID of the updated property

Throws:

WSFaultException

updateProperties

public void updateProperties(java.lang.String sessionId,
                             int requirementId,
                             PropertyValue[] properties)
                      throws WSFaultException

This method updates all provided property values. If some sort of locking has to be done, the property objects perform it within themselves.

Parameters:

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

requirementId - ID of the requirement that is to be updated

properties - list of properties that are to be updated

Throws:

WSFaultException

getAssignedTests

public Test[] getAssignedTests(java.lang.String sessionId,
                               int requirementId)
                        throws WSFaultException

This method returns all assigned tests for the provided requirement.

Parameters:

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

requirementId - ID of the requirement from which you want to get the assigned tests

Returns:

all assigned tests of the requirement that has the provided requirement ID

Throws:

WSFaultException

assignTest

public void assignTest(java.lang.String sessionId,
                       int requirementId,
                       int testId)
                throws WSFaultException

This method assigns the test with the provided test ID to the requirement with the provided requirement 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)

requirementId - ID of the requirement, that the test ID is to be assigned to

testId - ID of the test, that is to be assigned to the requirement

Throws:

WSFaultException

unassignTest

public void unassignTest(java.lang.String sessionId,
                         int requirementId,
                         int testId)
                  throws WSFaultException

This method unassigns the test with the provided test ID from the requirement with the provided requirement 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)

requirementId - ID of the requirement, that the test ID is to be unassigned from

testId - ID of the test, that is to be unassigned from the requirement

Throws:

WSFaultException

setRequirementFlagStatus

public void setRequirementFlagStatus(java.lang.String sessionId,
                                     int requirementId,
                                     int flagType,
                                     java.lang.Boolean includeChildren,
                                     java.lang.String comments)
                              throws WSFaultException

This method sets or clears a flag for a requirement and optionally its child requirements.

Parameters:

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

requirementId - ID of the requirement

flagType - NONE(0), FLAGGED(1)

includeChildren - indicates if child requirements need to be flagged

comments - flag comments

Throws:

WSFaultException

getCustomProperty

public CustomProperty getCustomProperty(java.lang.String sessionId,
                                        int propertyId)
                                 throws WSFaultException

Retrieves a CustomProperty object for the given propertyId.

Parameters:

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

propertyId - ID of an existing property

Returns:

a CustomProperty object; null on error or if no object for propertyId exists

Throws:

WSFaultException

getCustomProperties

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

Retrieves all CustomProperty objects for a 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 - ID of the project for which to retrieve the CustomProperty objects.

Returns:

an array of CustomProperty objects. The array is empty if no such project exists or if no custom properties are defined for the given project.

Throws:

WSFaultException

insertCustomProperty

public void insertCustomProperty(java.lang.String sessionId,
                                 CustomProperty newProperty)
                          throws WSFaultException

Parameters:

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

newProperty - the CustomProperty object to be added to a project Note: The project ID has to be set correctly in the CustomProperty object.

Throws:

WSFaultException

deleteCustomProperty

public void deleteCustomProperty(java.lang.String sessionId,
                                 int propertyId)
                          throws WSFaultException

Parameters:

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

propertyId - ID of the CustomProperty to be deleted

Throws:

WSFaultException