IGraphQLMutation (Java SDK API Client 0.9.0-SNAPSHOT API)

All Known Implementing Classes:

BaseGraphQLMutation, SpaceCreateGraphQLMutation, SpaceDeleteGraphQLMutation, SpaceMembersAddGraphQLMutation, SpaceMembersRemoveGraphQLMutation, SpaceUpdateGraphQLMutation
```
public interface IGraphQLMutation
```
Since:

0.6.0 Interface for BaseGraphQLMutation and concrete classes from that

Author:

Paul Withers

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`InputDataSenderBuilder`	`addInputField(String key, String value)` Helper method, to give easy access to `InputDataSenderBuilder.addField(String, Object)`
`InputDataSenderBuilder`	`addInputField(WWFieldsAttributesInterface enumName, Object value)` Helper method, to give easy access to `InputDataSenderBuilder.addField(WWFieldsAttributesInterface, Object)`
`IDataSenderBuilder`	`addReturnChild(IDataSenderBuilder child)` Helper method, to give easy access to `ObjectDataSenderBuilder.addChild(IDataSenderBuilder)`
`IDataSenderBuilder`	`addReturnField(String key)` Helper method, to give easy access to `ObjectDataSenderBuilder.addField(String)`
`IDataSenderBuilder`	`addReturnField(WWFieldsAttributesInterface enumName)` Helper method, to give easy access to `ObjectDataSenderBuilder.addField(WWFieldsAttributesInterface)`
`IGraphQLMutation`	`addReturnObject(IDataSenderBuilder returnObject)`
`IDataSenderBuilder`	`getFirstReturnObject()`
`Map<String,Object>`	`getInputFieldsMap()` Helper method, to give easy access to `InputDataSenderBuilder.getFieldsMap()`
`InputDataSenderBuilder`	`getInputObject()`
`String`	`getOperationName()`
`List<IDataSenderBuilder>`	`getReturnChildren()` Helper method, to give easy access to `ObjectDataSenderBuilder.getChildren()`
`List<String>`	`getReturnFieldsList()` Helper method, to give easy access to `ObjectDataSenderBuilder.getFieldsList()`
`String`	`getReturnObjectName()` Helper method, to give easy access to `ObjectDataSenderBuilder.getObjectName()`
`List<IDataSenderBuilder>`	`getReturnObjects()`
`int`	`hashCode()`
`InputDataSenderBuilder`	`removeInputField(String key)` Helper method, to give easy access to `InputDataSenderBuilder.removeField(String)`
`InputDataSenderBuilder`	`removeInputField(WWFieldsAttributesInterface enumName)` Helper method, to give easy access to `InputDataSenderBuilder.removeField(WWFieldsAttributesInterface)`
`IDataSenderBuilder`	`removeReturnChild(IDataSenderBuilder child)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeChild(IDataSenderBuilder)`
`IDataSenderBuilder`	`removeReturnField(String key)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeField(String)`
`IDataSenderBuilder`	`removeReturnField(WWFieldsAttributesInterface enumName)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeField(WWFieldsAttributesInterface)`
`IGraphQLMutation`	`removeReturnObject(IDataSenderBuilder returnObject)`
`String`	`returnQuery()` Returns the full query to be passed to WWS, building the JSON object from the InputDataSenderBuilder and ObjectDataSenderBuilder
`void`	`setInputFieldsMap(Map<String,Object> fieldsMap)` Helper method, to give easy access to `InputDataSenderBuilder.setFieldsMap(Map)`
`IDataSenderBuilder`	`setReturnChildren(List<IDataSenderBuilder> children)` Helper method, to give easy access to `ObjectDataSenderBuilder.setChildren(List)`
`void`	`setReturnFieldsList(List<String> fieldsList)` Helper method, to give easy access to `ObjectDataSenderBuilder.setFieldsList(List)`
`void`	`setReturnObjectName(String objectName)` Helper method, to give easy to `ObjectDataSenderBuilder.setObjectName(String)`

- Method Detail
  - getOperationName
```
String getOperationName()
```
    Returns:
    
    String, operation name
    
    Since:
    
    0.6.0
  - getFirstReturnObject
```
IDataSenderBuilder getFirstReturnObject()
```
    Returns:
    
    IDataSenderBuilder containing the query settings for the result of the mutation
    
    Since:
    
    0.6.0
  - getReturnObjects
```
List<IDataSenderBuilder> getReturnObjects()
```
    Returns:
    
    List of all IDataSenderBuilder objects
    
    Since:
    
    0.6.0
  - addReturnObject
```
IGraphQLMutation addReturnObject(IDataSenderBuilder returnObject)
```
    Parameters:
    
    returnObject - IDataSenderBuilder to add
    
    Returns:
    
    IGraphQLMutation current object
  - removeReturnObject
```
IGraphQLMutation removeReturnObject(IDataSenderBuilder returnObject)
```
    Parameters:
    
    returnObject - IDataSenderBuilder to remove
    
    Returns:
    
    IGraphQLMutation current object
  - getInputObject
```
InputDataSenderBuilder getInputObject()
```
    Returns:
    
    InputDataSenderBuilder containing the details to update via the mutation
    
    Since:
    
    0.6.0
  - returnQuery
```
String returnQuery()
```
    Returns the full query to be passed to WWS, building the JSON object from the InputDataSenderBuilder and ObjectDataSenderBuilder
    
    Returns:
    
    String query to pass to WWS containing "mutation", the operation name, a JSON object containing the update settings and a JSON object containing the query settings
    
    Since:
    
    0.6.0
  - getInputFieldsMap
```
Map<String,Object> getInputFieldsMap()
```
    Helper method, to give easy access to InputDataSenderBuilder.getFieldsMap()
    
    Returns:
    
    Map of fields and values to set via the mutation
    
    Since:
    
    0.6.0
  - setInputFieldsMap
```
void setInputFieldsMap(Map<String,Object> fieldsMap)
```
    Helper method, to give easy access to InputDataSenderBuilder.setFieldsMap(Map)
    
    Parameters:
    
    fieldsMap - Map of fields and values to set via the mutation
    
    Since:
    
    0.6.0
  - addInputField
```
InputDataSenderBuilder addInputField(String key,
                                     String value)
```
    Helper method, to give easy access to InputDataSenderBuilder.addField(String, Object)
    
    Parameters:
    
    key - String field name
    
    value - Object value to set
    
    Returns:
    
    InputDataSender, current object
    
    Since:
    
    0.6.0
  - addInputField
```
InputDataSenderBuilder addInputField(WWFieldsAttributesInterface enumName,
                                     Object value)
                              throws WWException
```
    Helper method, to give easy access to InputDataSenderBuilder.addField(WWFieldsAttributesInterface, Object)
    
    Parameters:
    
    enumName - WWFieldsAttributesInterface enum, whose label property is the name of the field to set via the mutation
    
    value - Object value to set
    
    Returns:
    
    InputDataSender, current object
    
    Throws:
    
    WWException - containing an error message, if the value is a different data type to what the enum expects
    
    Since:
    
    0.6.0
  - removeInputField
```
InputDataSenderBuilder removeInputField(String key)
```
    Helper method, to give easy access to InputDataSenderBuilder.removeField(String)
    
    Parameters:
    
    key - String field name
    
    Returns:
    
    InputDataSender, current object
    
    Since:
    
    0.6.0
  - removeInputField
```
InputDataSenderBuilder removeInputField(WWFieldsAttributesInterface enumName)
```
    Helper method, to give easy access to InputDataSenderBuilder.removeField(WWFieldsAttributesInterface)
    
    Parameters:
    
    enumName - WWFieldsAttributesInterface enum, whose label property is the name of the field to set via the mutation
    
    Returns:
    
    InputDataSender, current object
    
    Since:
    
    0.6.0
  - getReturnObjectName
```
String getReturnObjectName()
```
    Helper method, to give easy access to ObjectDataSenderBuilder.getObjectName()
    
    Returns:
    
    String the objectName property from queryObject property
    
    Since:
    
    0.6.0
  - setReturnObjectName
```
void setReturnObjectName(String objectName)
```
    Helper method, to give easy to ObjectDataSenderBuilder.setObjectName(String)
    
    Parameters:
    
    objectName - the objectName property from queryObject property
    
    Since:
    
    0.6.0
  - getReturnFieldsList
```
List<String> getReturnFieldsList()
```
    Helper method, to give easy access to ObjectDataSenderBuilder.getFieldsList()
    
    Returns:
    
    List of String fields queryObject of this Query
    
    Since:
    
    0.6.0
  - setReturnFieldsList
```
void setReturnFieldsList(List<String> fieldsList)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.setFieldsList(List)
    
    Parameters:
    
    fieldsList - List of String fields in the queryObject of this Query
    
    Since:
    
    0.6.0
  - addReturnField
```
IDataSenderBuilder addReturnField(String key)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.addField(String)
    
    Parameters:
    
    key - String field to add to the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder queryObject of this Query
    
    Since:
    
    0.6.0
  - addReturnField
```
IDataSenderBuilder addReturnField(WWFieldsAttributesInterface enumName)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.addField(WWFieldsAttributesInterface)
    
    Parameters:
    
    enumName - WWFIeldAttributesInterface field to add to the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder queryObject of this Query
    
    Since:
    
    0.6.0
  - removeReturnField
```
IDataSenderBuilder removeReturnField(String key)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.removeField(String)
    
    Parameters:
    
    key - String field to remove from the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder queryObject of this Query
    
    Since:
    
    0.6.0
  - removeReturnField
```
IDataSenderBuilder removeReturnField(WWFieldsAttributesInterface enumName)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.removeField(WWFieldsAttributesInterface)
    
    Parameters:
    
    enumName - WWFieldsAttributesInterface field to remove from the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder queryObject of this Query
    
    Since:
    
    0.6.0
  - getReturnChildren
```
List<IDataSenderBuilder> getReturnChildren()
```
    Helper method, to give easy access to ObjectDataSenderBuilder.getChildren()
    
    Returns:
    
    List of IDataSenderBuilders corresponding to the children of the queryObject of this Query
    
    Since:
    
    0.6.0
  - setReturnChildren
```
IDataSenderBuilder setReturnChildren(List<IDataSenderBuilder> children)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.setChildren(List)
    
    Parameters:
    
    children - List of DataSenderBuilders corresponding to the children of the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder, the query object of this Query
    
    Since:
    
    0.6.0
  - addReturnChild
```
IDataSenderBuilder addReturnChild(IDataSenderBuilder child)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.addChild(IDataSenderBuilder)
    
    Parameters:
    
    child - DataSenderBuilder for the child to be added to the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder, the query object of this Query
    
    Since:
    
    0.6.0
  - removeReturnChild
```
IDataSenderBuilder removeReturnChild(IDataSenderBuilder child)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.removeChild(IDataSenderBuilder)
    
    Parameters:
    
    child - DataSenderBuilder for the child to be removed from the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder, the query object of this Query
    
    Since:
    
    0.6.0
  - hashCode
```
int hashCode()
```
    Overrides:
    
    hashCode in class Object

Interface IGraphQLMutation

Method Summary

Method Detail

getOperationName

getFirstReturnObject

getReturnObjects

addReturnObject

removeReturnObject

getInputObject

returnQuery

getInputFieldsMap

setInputFieldsMap

addInputField

addInputField

removeInputField

removeInputField

getReturnObjectName

setReturnObjectName

getReturnFieldsList

setReturnFieldsList

addReturnField

addReturnField

removeReturnField

removeReturnField

getReturnChildren

setReturnChildren

addReturnChild

removeReturnChild

hashCode