TestLinkAPI (TestLink Java API 1.9.8-0 API)

java.lang.Object
- br.eti.kinoshita.testlinkjavaapi.TestLinkAPI

```
public class TestLinkAPI
extends Object
```
TestLink API class.

Since:

1.9.0-1

Author:

Bruno P. Kinoshita - http://www.kinoshita.eti.br

Constructor Summary

Constructors
Constructor and Description

TestLinkAPI(URL url, String devKey)
Constructor with parameters.

Constructors
Constructor and Description
`TestLinkAPI(URL url, String devKey)` Constructor with parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`about()` Displays information about TL.
`Map<String,Object>`	`addPlatformToTestPlan(Integer testProjectId, Integer testPlanId, String platformName)` Adds a platform to a test plan.
`Integer`	`addTestCaseToTestPlan(Integer testProjectId, Integer testPlanId, Integer testCaseId, Integer version, Integer platformId, Integer order, Integer urgency)` Adds a Test Case to a Test Plan.
`void`	`assignRequirements(Integer testCaseId, Integer testProjectId, List<Requirement> requirements)` Assign a requirements to a Test Case.
`Boolean`	`checkDevKey(String devKey)` Checks developer key.
`Build`	`createBuild(Integer testPlanId, String buildName, String buildNotes)` Creates a Build.
`TestCase`	`createTestCase(String testCaseName, Integer testSuiteId, Integer testProjectId, String authorLogin, String summary, List<TestCaseStep> steps, String preconditions, TestImportance importance, ExecutionType execution, Integer order, Integer internalId, Boolean checkDuplicatedName, ActionOnDuplicate actionOnDuplicatedName)` Creates a Test Case.
`Map<String,Object>`	`createTestCaseSteps(Integer testCaseId, String testCaseExternalId, Integer version, TestCaseStepAction action, List<TestCaseStep> testCaseSteps)` Create, Update or Push a list of TestCaseSteps in a Test Case.
`TestPlan`	`createTestPlan(String planName, String projectName, String notes, Boolean isActive, Boolean isPublic)` Creates a Test Plan.
`TestProject`	`createTestProject(String testProjectName, String testProjectPrefix, String notes, Boolean enableRequirements, Boolean enableTestPriority, Boolean enableAutomation, Boolean enableInventory, Boolean isActive, Boolean isPublic)` Creates a Test Project.
`TestSuite`	`createTestSuite(Integer testProjectId, String name, String details, Integer parentId, Integer order, Boolean checkDuplicatedName, ActionOnDuplicate actionOnDuplicatedName)`
`void`	`deleteExecution(Integer executionId)` Deletes an execution.
`Map<String,Object>`	`deleteTestCaseSteps(String testCaseExternalId, Integer version, List<TestCaseStep> testCaseSteps)` Delete a list if TestCaseSteps from a Test Case.
`Boolean`	`doesUserExist(String user)` Checks if the given user exists.
`Object`	`executeXmlRpcCall(String methodName, Map<String,Object> executionData)` Executes a XML-RPC call.
`Build[]`	`getBuildsForTestPlan(Integer testPlanId)` Retrieves an Array of Builds for a given Test Plan.
`String`	`getDevKey()`
`Map<String,Object>`	`getExecCountersByBuild(Integer testPlanId)` Gets the exec counters by build.
`TestSuite[]`	`getFirstLevelTestSuitesForTestProject(Integer testProjectId)` Get set of test suites AT TOP LEVEL of tree on a Test Project
`String[]`	`getFullPath(Integer nodeId)` Retrieves the full path of a node.
`Execution`	`getLastExecutionResult(Integer testPlanId, Integer testCaseId, Integer testCaseExternalId)` Retrieves last execution result of a Test Case.
`Build`	`getLatestBuildForTestPlan(Integer testPlanId)` Retrieves the latest Build for a given Test Plan.
`Platform[]`	`getProjectPlatforms(Integer projectId)` Retrieves the platforms of a test project.
`TestProject[]`	`getProjects()` Retrieves all Test Projects from TestLink.
`TestPlan[]`	`getProjectTestPlans(Integer projectId)` Retrieves an array of Test Plans associated to a Test Project.
`TestCase`	`getTestCase(Integer testCaseId, Integer testCaseExternalId, Integer version)` Get a test case
`Attachment[]`	`getTestCaseAttachments(Integer testCaseId, Integer testCaseExternalId)` Return an array of attachments of a Test Case.
`TestCase`	`getTestCaseByExternalId(String fullTestCaseExternalId, Integer version)` Get a Test Case using the full external id, composed by the prefix and the external id: prefix-externalId
`CustomField`	`getTestCaseCustomFieldDesignValue(Integer testCaseId, Integer testCaseExternalId, Integer versionNumber, Integer testProjectId, String customFieldName, ResponseDetails details)` Retrieves list of Custom Fields for a Test Case.
`protected CustomField`	`getTestCaseCustomFieldExecutionValue(Integer testCaseId, Integer testCaseExternalId, Integer versionNumber, Integer executionId, Integer testProjectId, String customFieldName, ResponseDetails details)` Gets the test case custom field value on test execution scope.
`protected CustomField`	`getTestCaseCustomFieldTestPlanDesignValue(Integer testCaseId, Integer testCaseExternalId, Integer versionNumber, Integer testProjectId, String customFieldName, ResponseDetails details)` Gets the test case custom field value on test plan design scope.
`Integer`	`getTestCaseIDByName(String testCaseName, String testSuiteName, String testProjectName, String testCasePathName)` Get a test case ID by a test case Name
`TestCase[]`	`getTestCasesForTestPlan(Integer testPlanId, List<Integer> testCasesIds, Integer buildId, List<Integer> keywordsIds, String keywords, Boolean executed, List<Integer> assignedTo, String[] executeStatus, ExecutionType executionType, Boolean getStepInfo, TestCaseDetails detail)` Retrieves Test Cases for Test Plans.
`TestCase[]`	`getTestCasesForTestSuite(Integer testSuiteId, Boolean deep, TestCaseDetails detail)` Retrieves Test Cases for a Test Suite.
`TestPlan`	`getTestPlanByName(String planName, String projectName)` Retrieves a Test Plan by its name.
`Platform[]`	`getTestPlanPlatforms(Integer planId)` Retrieves Platforms of a Test Plan.
`TestProject`	`getTestProjectByName(String projectName)` Retrieves a Test Project by its name.
`TestSuite[]`	`getTestSuiteByID(List<Integer> testSuiteIds)` Retrieves Test Suites for given Ids.
`TestSuite[]`	`getTestSuitesForTestPlan(Integer testPlanId)`
`TestSuite[]`	`getTestSuitesForTestSuite(Integer testSuiteId)` Get list of TestSuites which are DIRECT children of a given TestSuite
`Map<String,Object>`	`getTotalsForTestPlan(Integer testPlanId)` Gets stats for test plan.
`URL`	`getUrl()`
`User`	`getUserByLogin(String login)` Get user by login.
`org.apache.xmlrpc.client.XmlRpcClient`	`getXmlRpcClient()`
`String`	`ping()` ping method is an alias for sayHello.
`Map<String,Object>`	`removePlatformFromTestPlan(Integer testProjectId, Integer testPlanId, String platformName)` Removes a platform from a test plan.
`String`	`repeat(String str)`
`ReportTCResultResponse`	`reportTCResult(Integer testCaseId, Integer testCaseExternalId, Integer testPlanId, ExecutionStatus status, Integer buildId, String buildName, String notes, Boolean guess, String bugId, Integer platformId, String platformName, Map<String,String> customFields, Boolean overwrite)` Reports a Test Case result.
`String`	`sayHello()` Says hello to the user.
`ReportTCResultResponse`	`setTestCaseExecutionResult(Integer testCaseId, Integer testCaseExternalId, Integer testPlanId, ExecutionStatus status, Integer buildId, String buildName, String notes, Boolean guess, String bugId, Integer platformId, String platformName, Map<String,String> customFields, Boolean overwrite)` Reports a Test Case result.
`Map<String,Object>`	`setTestCaseExecutionType(Integer testProjectId, Integer testCaseId, Integer testCaseExternalId, Integer versionNumber, ExecutionType executionType)` Sets the test case execution type.
`Boolean`	`setTestMode(Boolean testMode)`
`String`	`toString()`
`Attachment`	`uploadAttachment(Integer fkId, String fkTable, String title, String description, String fileName, String fileType, String content)` Uploads an attachment linking it to a DB table.
`Attachment`	`uploadExecutionAttachment(Integer executionId, String title, String description, String fileName, String fileType, String content)`
`Attachment`	`uploadRequirementAttachment(Integer requirementId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Requirement.
`Attachment`	`uploadRequirementSpecificationAttachment(Integer reqSpecId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Requirement Specification.
`Attachment`	`uploadTestCaseAttachment(Integer testCaseId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Test Case.
`Attachment`	`uploadTestProjectAttachment(Integer testProjectId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Test Project.
`Attachment`	`uploadTestSuiteAttachment(Integer testSuiteId, String title, String description, String fileName, String fileType, String content)` Uploads an attachment to a Test Suite.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- TestLinkAPI
```
public TestLinkAPI(URL url,
           String devKey)
            throws TestLinkAPIException
```
  Constructor with parameters.
  Instantiates TestLink services. It also checks the devKey and throws a TestLinkAPIException if it is invalid.
  
  Parameters:
  url - The URL to set.
  devKey - The Developer Key to set.
  
  Throws:
  
  TestLinkAPIException
  Since:
  
  1.0

Method Detail

getXmlRpcClient

public org.apache.xmlrpc.client.XmlRpcClient getXmlRpcClient()

Returns:: XML-RPC Client.

getUrl
```
public URL getUrl()
```
Returns:
the url

getDevKey
```
public String getDevKey()
```
Returns:
the devKey

toString
```
public String toString()
```
Overrides:

toString in class Object

checkDevKey
```
public Boolean checkDevKey(String devKey)
                    throws TestLinkAPIException
```
Checks developer key.

Parameters:
devKey - Developer Key.

Returns:
true if devKey is valid, false otherwise.

Throws:

TestLinkAPIException
Since:

1.0

doesUserExist
```
public Boolean doesUserExist(String user)
                      throws TestLinkAPIException
```
Checks if the given user exists.

Parameters:
user -

Returns:
true if the user exists, false otherwise.

Throws:

TestLinkAPIException

getUserByLogin

public User getUserByLogin(String login)
                    throws TestLinkAPIException

Get user by login.

Parameters:: login -
Returns:: user
Throws:: TestLinkAPIException

ping
```
public String ping()
            throws TestLinkAPIException
```
ping method is an alias for sayHello.

Returns:
Hello message.

Throws:

TestLinkAPIException

sayHello
```
public String sayHello()
                throws TestLinkAPIException
```
Says hello to the user.

Returns:
Hello message.

Throws:

TestLinkAPIException

about
```
public String about()
             throws TestLinkAPIException
```
Displays information about TL.

Returns:
About text.

Throws:

TestLinkAPIException

setTestMode

public Boolean setTestMode(Boolean testMode)
                    throws TestLinkAPIException

Parameters:: testMode -
Returns:: Test mode.
Throws:: TestLinkAPIException

repeat

public String repeat(String str)
              throws TestLinkAPIException

Parameters:: str -
Returns:: String repeated.
Throws:: TestLinkAPIException

uploadAttachment

public Attachment uploadAttachment(Integer fkId,
                          String fkTable,
                          String title,
                          String description,
                          String fileName,
                          String fileType,
                          String content)
                            throws TestLinkAPIException

Uploads an attachment linking it to a DB table.

Parameters:: fkId -; fkTable -; title -; description -; fileName -; fileType -; content -
Returns:: Attachment.
Throws:: TestLinkAPIException

getFullPath
```
public String[] getFullPath(Integer nodeId)
                     throws TestLinkAPIException
```
Retrieves the full path of a node. Given a nodeId of, let's say, 10, that is a test case. The return array will consist of Name Of Project, Name of Suite, Name of Test Case.

Parameters:
nodeId -

Returns:
Array of name of nodes

Throws:

TestLinkAPIException

getLastExecutionResult

public Execution getLastExecutionResult(Integer testPlanId,
                               Integer testCaseId,
                               Integer testCaseExternalId)
                                 throws TestLinkAPIException

Retrieves last execution result of a Test Case.

Parameters:: testPlanId -; testCaseId -; testCaseExternalId -
Returns:: Last Execution.
Throws:: TestLinkAPIException

createTestProject

public TestProject createTestProject(String testProjectName,
                            String testProjectPrefix,
                            String notes,
                            Boolean enableRequirements,
                            Boolean enableTestPriority,
                            Boolean enableAutomation,
                            Boolean enableInventory,
                            Boolean isActive,
                            Boolean isPublic)
                              throws TestLinkAPIException

Creates a Test Project.

Parameters:: testProjectName -; testProjectPrefix -; notes -; enableRequirements -; enableTestPriority -; enableAutomation -; enableInventory -; isActive -; isPublic -
Returns:: Test Project object.
Throws:: TestLinkAPIException
Since:: 1.0

getTestProjectByName
```
public TestProject getTestProjectByName(String projectName)
                                 throws TestLinkAPIException
```
Retrieves a Test Project by its name.

Parameters:
projectName - Test Project name.

Returns:
Test Project with given name or null if not found.

Throws:

TestLinkAPIException
Since:

1.0

getProjectPlatforms
```
public Platform[] getProjectPlatforms(Integer projectId)
                               throws TestLinkAPIException
```
Retrieves the platforms of a test project.

Parameters:
projectId - test project ID

Returns:
platforms array

Throws:

TestLinkAPIException - if an error occurs when retrieving the platforms
Since:

1.9.6-0

getProjects
```
public TestProject[] getProjects()
                          throws TestLinkAPIException
```
Retrieves all Test Projects from TestLink.

Returns:
an array of Test Projects.

Throws:

TestLinkAPIException
Since:

1.0

getProjectTestPlans
```
public TestPlan[] getProjectTestPlans(Integer projectId)
                               throws TestLinkAPIException
```
Retrieves an array of Test Plans associated to a Test Project.

Parameters:
projectId - Test Project Id.

Returns:
Array of Test Plans.

Throws:

TestLinkAPIException

uploadTestProjectAttachment

public Attachment uploadTestProjectAttachment(Integer testProjectId,
                                     String title,
                                     String description,
                                     String fileName,
                                     String fileType,
                                     String content)
                                       throws TestLinkAPIException

Uploads an attachment to a Test Project.

Parameters:: testProjectId -; title -; description -; fileName -; fileType -; content -
Returns:: Attachment.
Throws:: TestLinkAPIException

createTestPlan

public TestPlan createTestPlan(String planName,
                      String projectName,
                      String notes,
                      Boolean isActive,
                      Boolean isPublic)
                        throws TestLinkAPIException

Creates a Test Plan.

Parameters:: planName - Test Plan name.; projectName - Test Project name.; notes - Test Plan notes.; isActive -; isPublic -
Throws:: TestLinkAPIException
Since:: 1.0

getTestPlanByName

public TestPlan getTestPlanByName(String planName,
                         String projectName)
                           throws TestLinkAPIException

Retrieves a Test Plan by its name.

Parameters:: planName - Test Plan name.; projectName - Test Project name.
Returns:: Test Plan.
Throws:: TestLinkAPIException
Since:: 1.0

getTestPlanPlatforms
```
public Platform[] getTestPlanPlatforms(Integer planId)
                                throws TestLinkAPIException
```
Retrieves Platforms of a Test Plan.

Parameters:
planId - Test Plan Id.

Returns:
Platforms.

Throws:

TestLinkAPIException

getTotalsForTestPlan

public Map<String,Object> getTotalsForTestPlan(Integer testPlanId)
                                        throws TestLinkAPIException

Gets stats for test plan.

Parameters:: testPlanId - test plan ID
Returns:: stats
Throws:: TestLinkAPIException

removePlatformFromTestPlan

public Map<String,Object> removePlatformFromTestPlan(Integer testProjectId,
                                            Integer testPlanId,
                                            String platformName)
                                              throws TestLinkAPIException

Removes a platform from a test plan.

Parameters:: testProjectId - test project ID; testPlanId - test plan ID; platformName - platform name
Returns:: status message
Throws:: TestLinkAPIException

addPlatformToTestPlan

public Map<String,Object> addPlatformToTestPlan(Integer testProjectId,
                                       Integer testPlanId,
                                       String platformName)
                                         throws TestLinkAPIException

Adds a platform to a test plan.

Parameters:: testProjectId - test project ID; testPlanId - test plan ID; platformName - platform name
Returns:: status message
Throws:: TestLinkAPIException

createBuild

public Build createBuild(Integer testPlanId,
                String buildName,
                String buildNotes)
                  throws TestLinkAPIException

Creates a Build.

Parameters:: testPlanId -; buildName -; buildNotes -
Returns:: Created Build.
Throws:: TestLinkAPIException

getBuildsForTestPlan
```
public Build[] getBuildsForTestPlan(Integer testPlanId)
                             throws TestLinkAPIException
```
Retrieves an Array of Builds for a given Test Plan.

Parameters:
testPlanId - Test Plan ID.

Returns:
Array of Builds.

Throws:

TestLinkAPIException

getLatestBuildForTestPlan
```
public Build getLatestBuildForTestPlan(Integer testPlanId)
                                throws TestLinkAPIException
```
Retrieves the latest Build for a given Test Plan.

Parameters:
testPlanId - Test Plan ID.

Returns:
Build.

Throws:

TestLinkAPIException

getExecCountersByBuild
```
public Map<String,Object> getExecCountersByBuild(Integer testPlanId)
```
Gets the exec counters by build.

Parameters:
testPlanId -

Returns:
Map

createTestSuite

public TestSuite createTestSuite(Integer testProjectId,
                        String name,
                        String details,
                        Integer parentId,
                        Integer order,
                        Boolean checkDuplicatedName,
                        ActionOnDuplicate actionOnDuplicatedName)
                          throws TestLinkAPIException

Throws:: TestLinkAPIException

getTestSuiteByID
```
public TestSuite[] getTestSuiteByID(List<Integer> testSuiteIds)
                             throws TestLinkAPIException
```
Retrieves Test Suites for given Ids.

Parameters:
testSuiteIds - List of Test Suite Ids.

Returns:
Array of Test Suites.

Throws:

TestLinkAPIException

uploadTestSuiteAttachment

public Attachment uploadTestSuiteAttachment(Integer testSuiteId,
                                   String title,
                                   String description,
                                   String fileName,
                                   String fileType,
                                   String content)
                                     throws TestLinkAPIException

Uploads an attachment to a Test Suite.

Parameters:: testSuiteId -; title -; description -; fileName -; fileType -; content -
Returns:: Attachment.
Throws:: TestLinkAPIException

getTestSuitesForTestPlan

public TestSuite[] getTestSuitesForTestPlan(Integer testPlanId)
                                     throws TestLinkAPIException

Parameters:: testPlanId -
Returns:: Array of Test Suites of Test Plan.
Throws:: TestLinkAPIException

getTestSuitesForTestSuite
```
public TestSuite[] getTestSuitesForTestSuite(Integer testSuiteId)
                                      throws TestLinkAPIException
```
Get list of TestSuites which are DIRECT children of a given TestSuite

Parameters:
testSuiteId -

Throws:

TestLinkAPIException

getFirstLevelTestSuitesForTestProject

public TestSuite[] getFirstLevelTestSuitesForTestProject(Integer testProjectId)
                                                  throws TestLinkAPIException

Get set of test suites AT TOP LEVEL of tree on a Test Project

Parameters:: testProjectId -
Throws:: TestLinkAPIException

createTestCase

public TestCase createTestCase(String testCaseName,
                      Integer testSuiteId,
                      Integer testProjectId,
                      String authorLogin,
                      String summary,
                      List<TestCaseStep> steps,
                      String preconditions,
                      TestImportance importance,
                      ExecutionType execution,
                      Integer order,
                      Integer internalId,
                      Boolean checkDuplicatedName,
                      ActionOnDuplicate actionOnDuplicatedName)
                        throws TestLinkAPIException

Creates a Test Case.

Parameters:: testCaseName -; testSuiteId -; testProjectId -; authorLogin -; summary -; steps -; preconditions -; importance -; execution -; order -; internalId -; checkDuplicatedName -; actionOnDuplicatedName -
Returns:: TestCase.
Throws:: TestLinkAPIException

createTestCaseSteps

public Map<String,Object> createTestCaseSteps(Integer testCaseId,
                                     String testCaseExternalId,
                                     Integer version,
                                     TestCaseStepAction action,
                                     List<TestCaseStep> testCaseSteps)
                                       throws TestLinkAPIException

Create, Update or Push a list of TestCaseSteps in a Test Case.

Parameters:: testCaseExternalId -; version -; testCaseSteps -
Returns:: a Map with results.
Throws:: TestLinkAPIException

deleteTestCaseSteps

public Map<String,Object> deleteTestCaseSteps(String testCaseExternalId,
                                     Integer version,
                                     List<TestCaseStep> testCaseSteps)
                                       throws TestLinkAPIException

Delete a list if TestCaseSteps from a Test Case.

Parameters:: testCaseExternalId -; version -; testCaseSteps -
Returns:: a Map with results.
Throws:: TestLinkAPIException

addTestCaseToTestPlan

public Integer addTestCaseToTestPlan(Integer testProjectId,
                            Integer testPlanId,
                            Integer testCaseId,
                            Integer version,
                            Integer platformId,
                            Integer order,
                            Integer urgency)
                              throws TestLinkAPIException

Adds a Test Case to a Test Plan.

Parameters:: testProjectId -; testPlanId -; testCaseId -; version -; platformId -; order -; urgency -
Returns:: Feature ID.
Throws:: TestLinkAPIException

getTestCasesForTestSuite

public TestCase[] getTestCasesForTestSuite(Integer testSuiteId,
                                  Boolean deep,
                                  TestCaseDetails detail)
                                    throws TestLinkAPIException

Retrieves Test Cases for a Test Suite.

Parameters:: testSuiteId -; deep -; detail -
Returns:: Array of Test Cases of the Test Suite.
Throws:: TestLinkAPIException

getTestCase

public TestCase getTestCase(Integer testCaseId,
                   Integer testCaseExternalId,
                   Integer version)
                     throws TestLinkAPIException

Get a test case

Parameters:: testCaseId -; testCaseExternalId -; version -
Returns:: Test Case.
Throws:: TestLinkAPIException

getTestCaseByExternalId
```
public TestCase getTestCaseByExternalId(String fullTestCaseExternalId,
                               Integer version)
                                 throws TestLinkAPIException
```
Get a Test Case using the full external id, composed by the prefix and the external id: prefix-externalId

Parameters:
fullTestCaseExternalId - Full external id: prefix-externalId
version -

Returns:
Test Case.

Throws:

TestLinkAPIException

getTestCasesForTestPlan

public TestCase[] getTestCasesForTestPlan(Integer testPlanId,
                                 List<Integer> testCasesIds,
                                 Integer buildId,
                                 List<Integer> keywordsIds,
                                 String keywords,
                                 Boolean executed,
                                 List<Integer> assignedTo,
                                 String[] executeStatus,
                                 ExecutionType executionType,
                                 Boolean getStepInfo,
                                 TestCaseDetails detail)
                                   throws TestLinkAPIException

Retrieves Test Cases for Test Plans.

Parameters:: testPlanId -; testCasesIds -; buildId -; keywordsIds -; keywords -; executed -; assignedTo -; executeStatus -; executionType -; getStepInfo -
Returns:: Array of Test Cases of the Test Plan.
Throws:: TestLinkAPIException

getTestCaseIDByName

public Integer getTestCaseIDByName(String testCaseName,
                          String testSuiteName,
                          String testProjectName,
                          String testCasePathName)
                            throws TestLinkAPIException

Get a test case ID by a test case Name

Parameters:: testCaseName -; testSuiteName -; testProjectName -; testCasePathName -
Returns:: Test Case ID.
Throws:: TestLinkAPIException

uploadTestCaseAttachment

public Attachment uploadTestCaseAttachment(Integer testCaseId,
                                  String title,
                                  String description,
                                  String fileName,
                                  String fileType,
                                  String content)
                                    throws TestLinkAPIException

Uploads an attachment to a Test Case.

Parameters:: testCaseId -; title -; description -; fileName -; fileType -; content -
Returns:: Attachment.
Throws:: TestLinkAPIException

getTestCaseAttachments

public Attachment[] getTestCaseAttachments(Integer testCaseId,
                                  Integer testCaseExternalId)
                                    throws TestLinkAPIException

Return an array of attachments of a Test Case.

Parameters:: testCaseId -; testCaseExternalId -
Returns:: Array of Attachments.
Throws:: TestLinkAPIException

uploadExecutionAttachment

public Attachment uploadExecutionAttachment(Integer executionId,
                                   String title,
                                   String description,
                                   String fileName,
                                   String fileType,
                                   String content)
                                     throws TestLinkAPIException

Throws:: TestLinkAPIException

deleteExecution

public void deleteExecution(Integer executionId)
                     throws TestLinkAPIException

Deletes an execution.

Parameters:: executionId - Execution Id.
Throws:: TestLinkAPIException

reportTCResult

public ReportTCResultResponse reportTCResult(Integer testCaseId,
                                    Integer testCaseExternalId,
                                    Integer testPlanId,
                                    ExecutionStatus status,
                                    Integer buildId,
                                    String buildName,
                                    String notes,
                                    Boolean guess,
                                    String bugId,
                                    Integer platformId,
                                    String platformName,
                                    Map<String,String> customFields,
                                    Boolean overwrite)
                                      throws TestLinkAPIException

Reports a Test Case result.

Parameters:: testCaseId -; testCaseExternalId -; testPlanId -; status -; buildId -; buildName -; notes -; guess -; bugId -; platformId -; platformName -; customFields -; overwrite -
Throws:: TestLinkAPIException

setTestCaseExecutionResult

public ReportTCResultResponse setTestCaseExecutionResult(Integer testCaseId,
                                                Integer testCaseExternalId,
                                                Integer testPlanId,
                                                ExecutionStatus status,
                                                Integer buildId,
                                                String buildName,
                                                String notes,
                                                Boolean guess,
                                                String bugId,
                                                Integer platformId,
                                                String platformName,
                                                Map<String,String> customFields,
                                                Boolean overwrite)
                                                  throws TestLinkAPIException

Reports a Test Case result.

Parameters:: testCaseId -; testCaseExternalId -; testPlanId -; status -; buildId -; buildName -; notes -; guess -; bugId -; platformId -; platformName -; customFields -; overwrite -
Throws:: TestLinkAPIException

getTestCaseCustomFieldDesignValue

public CustomField getTestCaseCustomFieldDesignValue(Integer testCaseId,
                                            Integer testCaseExternalId,
                                            Integer versionNumber,
                                            Integer testProjectId,
                                            String customFieldName,
                                            ResponseDetails details)
                                              throws TestLinkAPIException

Retrieves list of Custom Fields for a Test Case.

Parameters:: testCaseId -; testCaseExternalId -; versionNumber -; testProjectId -; customFieldName -
Returns:: Custom Field.
Throws:: TestLinkAPIException

getTestCaseCustomFieldTestPlanDesignValue

protected CustomField getTestCaseCustomFieldTestPlanDesignValue(Integer testCaseId,
                                                    Integer testCaseExternalId,
                                                    Integer versionNumber,
                                                    Integer testProjectId,
                                                    String customFieldName,
                                                    ResponseDetails details)
                                                         throws TestLinkAPIException

Gets the test case custom field value on test plan design scope.

Parameters:: testCaseId -; testCaseExternalId -; versionNumber -; testProjectId -; customFieldName -; details -
Returns:
Throws:: TestLinkAPIException

getTestCaseCustomFieldExecutionValue

protected CustomField getTestCaseCustomFieldExecutionValue(Integer testCaseId,
                                               Integer testCaseExternalId,
                                               Integer versionNumber,
                                               Integer executionId,
                                               Integer testProjectId,
                                               String customFieldName,
                                               ResponseDetails details)
                                                    throws TestLinkAPIException

Gets the test case custom field value on test execution scope.

Parameters:: testCaseId -; testCaseExternalId -; versionNumber -; executionId -; testProjectId -; customFieldName -; details -
Returns:
Throws:: TestLinkAPIException

setTestCaseExecutionType

public Map<String,Object> setTestCaseExecutionType(Integer testProjectId,
                                          Integer testCaseId,
                                          Integer testCaseExternalId,
                                          Integer versionNumber,
                                          ExecutionType executionType)

Sets the test case execution type.

Parameters:: testProjectId -; testCaseExternalId -; versionNumber -; executionType -
Returns:: Map

uploadRequirementSpecificationAttachment

public Attachment uploadRequirementSpecificationAttachment(Integer reqSpecId,
                                                  String title,
                                                  String description,
                                                  String fileName,
                                                  String fileType,
                                                  String content)
                                                    throws TestLinkAPIException

Uploads an attachment to a Requirement Specification.

Parameters:: reqSpecId -; title -; description -; fileName -; fileType -; content -
Returns:: Attachment.
Throws:: TestLinkAPIException

uploadRequirementAttachment

public Attachment uploadRequirementAttachment(Integer requirementId,
                                     String title,
                                     String description,
                                     String fileName,
                                     String fileType,
                                     String content)
                                       throws TestLinkAPIException

Uploads an attachment to a Requirement.

Parameters:: requirementId -; title -; description -; fileName -; fileType -; content -
Returns:: Attachment.
Throws:: TestLinkAPIException

assignRequirements

public void assignRequirements(Integer testCaseId,
                      Integer testProjectId,
                      List<Requirement> requirements)
                        throws TestLinkAPIException

Assign a requirements to a Test Case.

Parameters:: testCaseId -; testProjectId -; requirements -
Throws:: TestLinkAPIException

executeXmlRpcCall

public Object executeXmlRpcCall(String methodName,
                       Map<String,Object> executionData)
                         throws org.apache.xmlrpc.XmlRpcException,
                                TestLinkAPIException

Executes a XML-RPC call. Use this method to talk with TestLink in a lower level.

Parameters:: methodName - Name of the method.; executionData - Execution data map.
Returns:: Object returned from the server.
Throws:: org.apache.xmlrpc.XmlRpcException; TestLinkAPIException

Class TestLinkAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TestLinkAPI

Method Detail

getXmlRpcClient

getUrl

getDevKey

toString

checkDevKey

doesUserExist