SlickClient (slickqa-java-client 1.0.0 API)

All Known Implementing Classes:

SlickClientImpl
```
public interface SlickClient
```
The main interface for a slick client api. The slick client api is a builder pattern for making requests. This means that parameters passed into a parent object will be the context for what the child object will do. Because of this you do not want to keep reference to any of the Api instances other than the SlickClient instance. Ok, that was probably too boring to help. So how about 3 concise code samples to show how to use the api.
Example 1

In this example we will simply fetch a list of projects from slick, then print them out to the console. This example is purposefully simplistic. It shows how to get started.
```
     SlickClient slick = SlickClientFactory.getSlickClient("http://localhost/slick/api");
     List<Project> projects = null;
     try {
         projects = slick.projects().getList();
     } catch(SlickError e) {
         System.err.println("Error retrieving list of projects from slick: " + e.getMessage());
     }
     if (projects != null) {
         System.out.println("Projects in slick:");
         System.out.println("------------------");
         for(Project project : projects) {
             System.out.println(project.toString());
         }
     } else {
         System.out.println("Nothing to see here, move along.");
     }
 
```
Author:

Jason Corbett Created by jcorbett on 4/6/14.

Method Summary

Methods
Modifier and Type	Method and Description
`RetrieveUpdateDeleteApi<Configuration>`	`configuration(String idOrName)` Perform operations against a specific configuration.
`QueryAndCreateApi<Configuration>`	`configurations()` No filtering, retrieve all configurations.
`QueryAndCreateApi<Configuration>`	`configurations(Map<String,String> properties)` Filter based on properties of a configuration.
`QueryAndCreateApi<Configuration>`	`configurations(String query)` Filter the results based of a standard slick query.
`QueryAndCreateApi<Configuration>`	`configurations(String query, String orderBy)` Filter the results based of a standard slick query, setting a property to order the results by.
`QueryAndCreateApi<Configuration>`	`configurations(String query, String orderBy, Integer limit, Integer skip)` Filter the results based of a standard slick query, setting a property to order the results by.
`FilesApi`	`file(String id)` Access a specific stored file.
`FilesQueryApi`	`files()` Create and Upload a file to slick.
`ProjectApi`	`project(String idOrName)` Perform operations against a specific project.
`QueryAndCreateApi<Project>`	`projects()` No filtering, retrieve all projects.
`QueryAndCreateApi<Project>`	`projects(Map<String,String> properties)` Filter based on properties of a project.
`QueryAndCreateApi<Project>`	`projects(String query)` Filter the results based of a standard slick query.
`QueryAndCreateApi<Project>`	`projects(String query, String orderBy)` Filter the results based of a standard slick query, setting a property to order the results by.
`QueryAndCreateApi<Project>`	`projects(String query, String orderBy, Integer limit, Integer skip)` Filter the results based of a standard slick query, setting a property to order the results by.
`ResultApi`	`result(String idOrName)` Perform operations against a specific result.
`ResultQueryApi`	`results()` No filtering, retrieve all results.
`ResultQueryApi`	`results(Map<String,String> properties)` Filter based on properties of a result.
`ResultQueryApi`	`results(String query)` Filter the results based of a standard slick query.
`ResultQueryApi`	`results(String query, String orderBy)` Filter the results based of a standard slick query, setting a property to order the results by.
`ResultQueryApi`	`results(String query, String orderBy, Integer limit, Integer skip)` Filter the results based of a standard slick query, setting a property to order the results by.
`RetrieveUpdateDeleteApi<Testcase>`	`testcase(String idOrName)` Perform operations against a specific testcase.
`QueryAndCreateApi<Testcase>`	`testcases()` No filtering, retrieve all testcases.
`QueryAndCreateApi<Testcase>`	`testcases(Map<String,String> properties)` Filter based on properties of a testcase.
`QueryAndCreateApi<Testcase>`	`testcases(String query)` Filter the results based of a standard slick query.
`QueryAndCreateApi<Testcase>`	`testcases(String query, String orderBy)` Filter the results based of a standard slick query, setting a property to order the results by.
`QueryAndCreateApi<Testcase>`	`testcases(String query, String orderBy, Integer limit, Integer skip)` Filter the results based of a standard slick query, setting a property to order the results by.
`RetrieveUpdateDeleteApi<TestPlan>`	`testplan(String idOrName)` Perform operations against a specific testplan.
`QueryAndCreateApi<TestPlan>`	`testplans()` No filtering, retrieve all testplans.
`QueryAndCreateApi<TestPlan>`	`testplans(Map<String,String> properties)` Filter based on properties of a testplan.
`QueryAndCreateApi<TestPlan>`	`testplans(String query)` Filter the results based of a standard slick query.
`QueryAndCreateApi<TestPlan>`	`testplans(String query, String orderBy)` Filter the results based of a standard slick query, setting a property to order the results by.
`QueryAndCreateApi<TestPlan>`	`testplans(String query, String orderBy, Integer limit, Integer skip)` Filter the results based of a standard slick query, setting a property to order the results by.
`RetrieveUpdateDeleteApi<Testrun>`	`testrun(String idOrName)` Perform operations against a specific testrun.
`QueryAndCreateApi<Testrun>`	`testruns()` No filtering, retrieve all testruns.
`QueryAndCreateApi<Testrun>`	`testruns(Map<String,String> properties)` Filter based on properties of a testrun.
`QueryAndCreateApi<Testrun>`	`testruns(String query)` Filter the results based of a standard slick query.
`QueryAndCreateApi<Testrun>`	`testruns(String query, String orderBy)` Filter the results based of a standard slick query, setting a property to order the results by.
`QueryAndCreateApi<Testrun>`	`testruns(String query, String orderBy, Integer limit, Integer skip)` Filter the results based of a standard slick query, setting a property to order the results by.

- Method Detail
  - projects
```
QueryAndCreateApi<Project> projects()
```
    No filtering, retrieve all projects.
  - projects
```
QueryAndCreateApi<Project> projects(Map<String,String> properties)
```
    Filter based on properties of a project. Dotted sub properties are allowed.
    
    Parameters:
    properties - A map of properties and their values to filter the projects by.
  - projects
```
QueryAndCreateApi<Project> projects(String query)
```
    Filter the results based of a standard slick query.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
  - projects
```
QueryAndCreateApi<Project> projects(String query,
                                  String orderBy)
```
    Filter the results based of a standard slick query, setting a property to order the results by.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
  - projects
```
QueryAndCreateApi<Project> projects(String query,
                                  String orderBy,
                                  Integer limit,
                                  Integer skip)
```
    Filter the results based of a standard slick query, setting a property to order the results by. Also you can specify a limit to the number of results and set a number of results to skip (for paging purposes).
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
    limit - The maximum number of results to return, or null for no limit.
    skip - The number of results to skip (maintaining order), or null for no skip.
  - project
```
ProjectApi project(String idOrName)
```
    Perform operations against a specific project. You only need to enter the ID (or name) here.
    
    Parameters:
    idOrName - The id (string representation of the BSON Object Id) or the name of the project.
  - configurations
```
QueryAndCreateApi<Configuration> configurations()
```
    No filtering, retrieve all configurations.
  - configurations
```
QueryAndCreateApi<Configuration> configurations(Map<String,String> properties)
```
    Filter based on properties of a configuration. Dotted sub properties are allowed.
    
    Parameters:
    properties - A map of properties and their values to filter the configurations by.
  - configurations
```
QueryAndCreateApi<Configuration> configurations(String query)
```
    Filter the results based of a standard slick query.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
  - configurations
```
QueryAndCreateApi<Configuration> configurations(String query,
                                              String orderBy)
```
    Filter the results based of a standard slick query, setting a property to order the results by.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
  - configurations
```
QueryAndCreateApi<Configuration> configurations(String query,
                                              String orderBy,
                                              Integer limit,
                                              Integer skip)
```
    Filter the results based of a standard slick query, setting a property to order the results by. Also you can specify a limit to the number of results and set a number of results to skip (for paging purposes). For any parameters you don't want to specify, null is allowed.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
    limit - The maximum number of results to return, or null for no limit.
    skip - The number of results to skip (maintaining order), or null for no skip.
  - configuration
```
RetrieveUpdateDeleteApi<Configuration> configuration(String idOrName)
```
    Perform operations against a specific configuration. You only need to enter the ID (or name) here.
    
    Parameters:
    idOrName - The id (string representation of the BSON Object Id) or the name of the configuration.
  - results
```
ResultQueryApi results()
```
    No filtering, retrieve all results.
  - results
```
ResultQueryApi results(Map<String,String> properties)
```
    Filter based on properties of a result. Dotted sub properties are allowed.
    
    Parameters:
    properties - A map of properties and their values to filter the results by.
  - results
```
ResultQueryApi results(String query)
```
    Filter the results based of a standard slick query.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
  - results
```
ResultQueryApi results(String query,
                     String orderBy)
```
    Filter the results based of a standard slick query, setting a property to order the results by.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
  - results
```
ResultQueryApi results(String query,
                     String orderBy,
                     Integer limit,
                     Integer skip)
```
    Filter the results based of a standard slick query, setting a property to order the results by. Also you can specify a limit to the number of results and set a number of results to skip (for paging purposes). For any parameters you don't want to specify, null is allowed.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
    limit - The maximum number of results to return, or null for no limit.
    skip - The number of results to skip (maintaining order), or null for no skip.
  - result
```
ResultApi result(String idOrName)
```
    Perform operations against a specific result. You only need to enter the ID (or name) here.
    
    Parameters:
    idOrName - The id (string representation of the BSON Object Id) or the name of the result.
  - testplans
```
QueryAndCreateApi<TestPlan> testplans()
```
    No filtering, retrieve all testplans.
  - testplans
```
QueryAndCreateApi<TestPlan> testplans(Map<String,String> properties)
```
    Filter based on properties of a testplan. Dotted sub properties are allowed.
    
    Parameters:
    properties - A map of properties and their values to filter the testplans by.
  - testplans
```
QueryAndCreateApi<TestPlan> testplans(String query)
```
    Filter the results based of a standard slick query.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
  - testplans
```
QueryAndCreateApi<TestPlan> testplans(String query,
                                    String orderBy)
```
    Filter the results based of a standard slick query, setting a property to order the results by.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
  - testplans
```
QueryAndCreateApi<TestPlan> testplans(String query,
                                    String orderBy,
                                    Integer limit,
                                    Integer skip)
```
    Filter the results based of a standard slick query, setting a property to order the results by. Also you can specify a limit to the number of results and set a number of results to skip (for paging purposes). For any parameters you don't want to specify, null is allowed.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
    limit - The maximum number of results to return, or null for no limit.
    skip - The number of results to skip (maintaining order), or null for no skip.
  - testplan
```
RetrieveUpdateDeleteApi<TestPlan> testplan(String idOrName)
```
    Perform operations against a specific testplan. You only need to enter the ID (or name) here.
    
    Parameters:
    idOrName - The id (string representation of the BSON Object Id) or the name of the testplan.
  - testcases
```
QueryAndCreateApi<Testcase> testcases()
```
    No filtering, retrieve all testcases.
  - testcases
```
QueryAndCreateApi<Testcase> testcases(Map<String,String> properties)
```
    Filter based on properties of a testcase. Dotted sub properties are allowed.
    
    Parameters:
    properties - A map of properties and their values to filter the testcases by.
  - testcases
```
QueryAndCreateApi<Testcase> testcases(String query)
```
    Filter the results based of a standard slick query.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
  - testcases
```
QueryAndCreateApi<Testcase> testcases(String query,
                                    String orderBy)
```
    Filter the results based of a standard slick query, setting a property to order the results by.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
  - testcases
```
QueryAndCreateApi<Testcase> testcases(String query,
                                    String orderBy,
                                    Integer limit,
                                    Integer skip)
```
    Filter the results based of a standard slick query, setting a property to order the results by. Also you can specify a limit to the number of results and set a number of results to skip (for paging purposes). For any parameters you don't want to specify, null is allowed.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
    limit - The maximum number of results to return, or null for no limit.
    skip - The number of results to skip (maintaining order), or null for no skip.
  - testcase
```
RetrieveUpdateDeleteApi<Testcase> testcase(String idOrName)
```
    Perform operations against a specific testcase. You only need to enter the ID (or name) here.
    
    Parameters:
    idOrName - The id (string representation of the BSON Object Id) or the name of the testcase.
  - files
```
FilesQueryApi files()
```
    Create and Upload a file to slick. StoredFiles have to be created first before being added to a Result. There is no generic query api for files.
    
    Returns:
    The api to create and possibly upload data for StoredFiles
  - file
```
FilesApi file(String id)
```
    Access a specific stored file. You can update the metadata about the file, or add data to the file.
    
    Parameters:
    id - The id of the StoredFile that you want to access.
    
    Returns:
    The Api for getting and updating a StoredFile
  - testruns
```
QueryAndCreateApi<Testrun> testruns()
```
    No filtering, retrieve all testruns.
  - testruns
```
QueryAndCreateApi<Testrun> testruns(Map<String,String> properties)
```
    Filter based on properties of a testrun. Dotted sub properties are allowed.
    
    Parameters:
    properties - A map of properties and their values to filter the testruns by.
  - testruns
```
QueryAndCreateApi<Testrun> testruns(String query)
```
    Filter the results based of a standard slick query.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
  - testruns
```
QueryAndCreateApi<Testrun> testruns(String query,
                                  String orderBy)
```
    Filter the results based of a standard slick query, setting a property to order the results by.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
  - testruns
```
QueryAndCreateApi<Testrun> testruns(String query,
                                  String orderBy,
                                  Integer limit,
                                  Integer skip)
```
    Filter the results based of a standard slick query, setting a property to order the results by. Also you can specify a limit to the number of results and set a number of results to skip (for paging purposes). For any parameters you don't want to specify, null is allowed.
    
    Parameters:
    query - The query to perform, using slick's generic query language.
    orderBy - The name of the property to order the results by. Prefix with a '-' for descending order.
    limit - The maximum number of results to return, or null for no limit.
    skip - The number of results to skip (maintaining order), or null for no skip.
  - testrun
```
RetrieveUpdateDeleteApi<Testrun> testrun(String idOrName)
```
    Perform operations against a specific testrun. You only need to enter the ID (or name) here.
    
    Parameters:
    idOrName - The id (string representation of the BSON Object Id) or the name of the testrun.

Interface SlickClient

Example 1

Method Summary

Method Detail

projects

projects

projects

projects

projects

project

configurations

configurations

configurations

configurations

configurations

configuration

results

results

results

results

results

result

testplans

testplans

testplans

testplans

testplans

testplan

testcases

testcases

testcases

testcases

testcases

testcase

files

file

testruns

testruns

testruns

testruns

testruns

testrun