GraphQLRequest (Java SDK API Client 0.9.0-SNAPSHOT API)

java.lang.Object
- org.opencode4workspace.json.GraphQLRequest

```
public class GraphQLRequest
extends Object
```
Since:

0.5.0 A class for handling GraphQL requests

Author:

Christian Guedemann, Paul Withers

Constructor Summary

Constructors
Constructor and Description
`GraphQLRequest(BaseGraphQLMutation mutationObject)` Initialises the GraphQLRequest object from a BaseGraphQLMutation object.
`GraphQLRequest(BaseGraphQLMutation mutationObject, HashMap<String,String> variables)` Initialises the GraphQLRequest object from a BaseGraphQLMutation object.
`GraphQLRequest(BaseGraphQLMutation mutationObject, HashMap<String,String> variables, String operationName)` Initialises the GraphQLRequest object from all properties
`GraphQLRequest(IGraphQLQuery queryObject)` Initialises the GraphQLRequest object from a BaseGraphQLQuery object.
`GraphQLRequest(IGraphQLQuery queryObject, HashMap<String,String> variables)` Initialises the GraphQLRequest object from a BaseGraphQLQuery object.
`GraphQLRequest(ObjectDataSenderBuilder queryObject, HashMap<String,String> variables, String operationName)` Initialises the GraphQLRequest from an ObjectDataBringer, operation name and variables.
`GraphQLRequest(ObjectDataSenderBuilder queryObject, String operationName)` Initialises the GraphQLRequest from an ObjectDataBringer and operation name.
`GraphQLRequest(String query, HashMap<String,String> variables, String operationName)` Initialises the GraphQLRequest object from all properties

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addReturnObjectType(ObjectDataSenderBuilder singleQueryObject)` Add a return type to the Map
`String`	`getOperationName()`
`String`	`getQuery()`
`Map<String,WWQueryResponseObjectInterface>`	`getReturnObjectTypes()` If the query includes aliases we need to parse them out.
`HashMap<String,String>`	`getVariables()`
`void`	`setOperationName(String operationName)`
`void`	`setQuery(String query)`
`void`	`setReturnObjectTypes(Map<String,WWQueryResponseObjectInterface> returnObjectTypes)` Setter for returnObjectTypes
`void`	`setVariables(HashMap<String,String> variables)`

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

- Constructor Detail
  - GraphQLRequest
```
public GraphQLRequest(String query,
                      HashMap<String,String> variables,
                      String operationName)
```
    Initialises the GraphQLRequest object from all properties
    
    Parameters:
    
    query - String, query passed
    
    variables - HashMap, dynamic variables passed with key as variable name, value as variable value
    
    operationName - String, operation name for the query
    
    Since:
    
    0.5.0
  - GraphQLRequest
```
public GraphQLRequest(IGraphQLQuery queryObject)
               throws WWException
```
    Initialises the GraphQLRequest object from a BaseGraphQLQuery object. This will have the operation name and will not pass any variables to Watson Work Services
    
    Parameters:
    
    queryObject - BaseGraphQLQuery containing an ObjectDataSenderBuilder which will be parsed to return the full query
    
    Throws:
    
    WWException - error if encountered parsing the queryObject
    
    Since:
    
    0.5.0
  - GraphQLRequest
```
public GraphQLRequest(IGraphQLQuery queryObject,
                      HashMap<String,String> variables)
               throws WWException
```
    Initialises the GraphQLRequest object from a BaseGraphQLQuery object. This will have the operation name.
    
    Parameters:
    
    queryObject - BaseGraphQLQuery containing an ObjectDataSenderBuilder which will be parsed to return the full query
    
    variables - HashMap of variables to pass with the query, where the key is the variable name and the value is the variable value
    
    Throws:
    
    WWException - error if encountered parsing the queryObject
    
    Since:
    
    0.5.0
  - GraphQLRequest
```
public GraphQLRequest(BaseGraphQLMutation mutationObject)
               throws WWException
```
    Initialises the GraphQLRequest object from a BaseGraphQLMutation object. This will have the operation name and will not pass any variables to Watson Work Services
    
    Parameters:
    
    mutationObject - BaseGraphQLMutation object containing InputDataSenderBuilder and ObjectDataSenderBuilder objects which will be parsed to return the full query
    
    Throws:
    
    WWException - error if encountered parsing the queryObject
    
    Since:
    
    0.6.0
  - GraphQLRequest
```
public GraphQLRequest(BaseGraphQLMutation mutationObject,
                      HashMap<String,String> variables)
               throws WWException
```
    Initialises the GraphQLRequest object from a BaseGraphQLMutation object. This will have the operation name
    
    Parameters:
    
    mutationObject - BaseGraphQLMutation object containing InputDataSenderBuilder and ObjectDataSenderBuilder objects which will be parsed to return the full query
    
    variables - HashMap of variables to pass with the query, where the key is the variable name and the value is the variable value
    
    Throws:
    
    WWException - error if encountered parsing the queryObject
    
    Since:
    
    0.6.0
  - GraphQLRequest
```
public GraphQLRequest(BaseGraphQLMutation mutationObject,
                      HashMap<String,String> variables,
                      String operationName)
               throws WWException
```
    Initialises the GraphQLRequest object from all properties
    
    Parameters:
    
    mutationObject - BaseGraphQLMutation object containing InputDataSenderBuilder and ObjectDataSenderBuilder objects which will be parsed to return the full query
    
    variables - HashMap of variables to pass with the query, where the key is the variable name and the value is the variable value
    
    operationName - String, operation name for the query
    
    Throws:
    
    WWException - error if encountered parsing the queryObject
    
    Since:
    
    0.6.0
  - GraphQLRequest
```
public GraphQLRequest(ObjectDataSenderBuilder queryObject,
                      String operationName)
               throws WWException
```
    Initialises the GraphQLRequest from an ObjectDataBringer and operation name. Those will be combined to build the String query. This will not pass any variables to Watson Work Services.
    
    Parameters:
    
    queryObject - ObjectDataBringer containing the query settings
    
    operationName - String operationName to use
    
    Throws:
    
    WWException - error if encountered parsing the queryObject
    
    Since:
    
    0.5.0
  - GraphQLRequest
```
public GraphQLRequest(ObjectDataSenderBuilder queryObject,
                      HashMap<String,String> variables,
                      String operationName)
               throws WWException
```
    Initialises the GraphQLRequest from an ObjectDataBringer, operation name and variables. Those will be combined to build the String query.
    
    Parameters:
    
    queryObject - ObjectDataBringer containing the query settings
    
    variables - HashMap of variables to pass with the query, where the key is the variable name and the value is the variable value
    
    operationName - String operationName to use
    
    Throws:
    
    WWException - error if encountered parsing the queryObject
    
    Since:
    
    0.5.0
- Method Detail
  - addReturnObjectType
```
public void addReturnObjectType(ObjectDataSenderBuilder singleQueryObject)
```
    Add a return type to the Map
    
    Parameters:
    
    singleQueryObject - a single ObjectDataSenderBuilder from which to get return type and object name
    
    Since:
    
    0.8.0
  - getQuery
```
public String getQuery()
```
    Returns:
    
    String, query passed
    
    Since:
    
    0.5.0
  - setQuery
```
public void setQuery(String query)
```
    Parameters:
    
    query - String, query passed
    
    Since:
    
    0.5.0
  - getVariables
```
public HashMap<String,String> getVariables()
```
    Returns:
    
    HashMap, dynamic variables passed with key as variable name, value as variable value
    
    Since:
    
    0.5.0
  - setVariables
```
public void setVariables(HashMap<String,String> variables)
```
    Parameters:
    
    variables - HashMap, dynamic variables passed with key as variable name, value as variable value
    
    Since:
    
    0.5.0
  - getOperationName
```
public String getOperationName()
```
    Returns:
    
    String, name of operation being performed
    
    Since:
    
    0.5.0
  - setOperationName
```
public void setOperationName(String operationName)
```
    Parameters:
    
    operationName - String, name of operation being performed
    
    Since:
    
    0.5.0
  - getReturnObjectTypes
```
public Map<String,WWQueryResponseObjectInterface> getReturnObjectTypes()
```
    If the query includes aliases we need to parse them out. This list will hold the alias and the enum type e.g. "space1", WWQueryResponseObjectTypes.SPACE "space2", WWQueryResponseObjectTypes.SPACE These are pulled if a BaseGraphQLMultiQuery is the type of IGraphQLQuery passed in This means we know what to cast the return object to, in this case SpaceWrapper
    
    Returns:
    
    alias name the user wants to cast the return object to, and enum holding details
    
    Since:
    
    0.7.0
  - setReturnObjectTypes
```
public void setReturnObjectTypes(Map<String,WWQueryResponseObjectInterface> returnObjectTypes)
```
    Setter for returnObjectTypes
    
    Parameters:
    
    returnObjectTypes - Map of alias name and enum holding details
    
    Since:
    
    0.7.0

Class GraphQLRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphQLRequest

GraphQLRequest

GraphQLRequest

GraphQLRequest

GraphQLRequest

GraphQLRequest

GraphQLRequest

GraphQLRequest

Method Detail

addReturnObjectType

getQuery

setQuery

getVariables

setVariables

getOperationName

setOperationName

getReturnObjectTypes

setReturnObjectTypes