BaseGraphQLMutation (Java SDK API Client 0.9.0-SNAPSHOT API)

java.lang.Object
- org.opencode4workspace.builders.BaseGraphQLMutation

All Implemented Interfaces:

Serializable, IGraphQLMutation

Direct Known Subclasses:

SpaceCreateGraphQLMutation, SpaceDeleteGraphQLMutation, SpaceMembersAddGraphQLMutation, SpaceMembersRemoveGraphQLMutation, SpaceUpdateGraphQLMutation
```
public class BaseGraphQLMutation
extends Object
implements Serializable, IGraphQLMutation
```
Since:

0.6.0 Abstract object for creating GraphQL Query. Use one of the in-built options

Author:

Paul Withers

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`BaseGraphQLMutation(String operationName, InputDataSenderBuilder inputObject, IDataSenderBuilder... returnObject)` Constructor, passing in multiple return objects to build the query
`BaseGraphQLMutation(String operationName, InputDataSenderBuilder inputObject, IDataSenderBuilder returnObject)` Constructor, passing in everything required to build the query

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InputDataSenderBuilder`	`addInputField(String field, String value)` Helper method, to give easy access to `InputDataSenderBuilder.addField(String, Object)`
`InputDataSenderBuilder`	`addInputField(WWFieldsAttributesInterface field, Object value)` Helper method, to give easy access to `InputDataSenderBuilder.addField(WWFieldsAttributesInterface, Object)`
`ObjectDataSenderBuilder`	`addReturnChild(IDataSenderBuilder child)` Helper method, to give easy access to `ObjectDataSenderBuilder.addChild(IDataSenderBuilder)`
`ObjectDataSenderBuilder`	`addReturnField(String field)` Helper method, to give easy access to `ObjectDataSenderBuilder.addField(String)`
`ObjectDataSenderBuilder`	`addReturnField(WWFieldsAttributesInterface field)` 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 field)` Helper method, to give easy access to `InputDataSenderBuilder.removeField(String)`
`InputDataSenderBuilder`	`removeInputField(WWFieldsAttributesInterface field)` Helper method, to give easy access to `InputDataSenderBuilder.removeField(WWFieldsAttributesInterface)`
`ObjectDataSenderBuilder`	`removeReturnChild(IDataSenderBuilder child)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeChild(IDataSenderBuilder)`
`ObjectDataSenderBuilder`	`removeReturnField(String field)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeField(String)`
`ObjectDataSenderBuilder`	`removeReturnField(WWFieldsAttributesInterface field)` 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)`
`ObjectDataSenderBuilder`	`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)`

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

- Constructor Detail
  - BaseGraphQLMutation
```
public BaseGraphQLMutation(String operationName,
                           InputDataSenderBuilder inputObject,
                           IDataSenderBuilder returnObject)
```
    Constructor, passing in everything required to build the query
    
    Parameters:
    
    operationName - String, operation name
    
    inputObject - InputDataSenderBuilder containing the input to pass to the mutation
    
    returnObject - IDataSenderBuilder containing the query settings
  - BaseGraphQLMutation
```
public BaseGraphQLMutation(String operationName,
                           InputDataSenderBuilder inputObject,
                           IDataSenderBuilder... returnObject)
```
    Constructor, passing in multiple return objects to build the query
    
    Parameters:
    
    operationName - String, operation name
    
    inputObject - InputDataSenderBuilder containing the input to pass to the mutation
    
    returnObject - IDataSenderBuilder containing the query settings
- Method Detail
  - getOperationName
```
public String getOperationName()
```
    Specified by:
    
    getOperationName in interface IGraphQLMutation
    
    Returns:
    
    String, operation name
  - getReturnObjects
```
public List<IDataSenderBuilder> getReturnObjects()
```
    Specified by:
    
    getReturnObjects in interface IGraphQLMutation
    
    Returns:
    
    List of all IDataSenderBuilder objects
  - getFirstReturnObject
```
public IDataSenderBuilder getFirstReturnObject()
```
    Specified by:
    
    getFirstReturnObject in interface IGraphQLMutation
    
    Returns:
    
    IDataSenderBuilder containing the query settings for the result of the mutation
  - addReturnObject
```
public IGraphQLMutation addReturnObject(IDataSenderBuilder returnObject)
```
    Specified by:
    
    addReturnObject in interface IGraphQLMutation
    
    Parameters:
    
    returnObject - IDataSenderBuilder to add
    
    Returns:
    
    IGraphQLMutation current object
  - removeReturnObject
```
public IGraphQLMutation removeReturnObject(IDataSenderBuilder returnObject)
```
    Specified by:
    
    removeReturnObject in interface IGraphQLMutation
    
    Parameters:
    
    returnObject - IDataSenderBuilder to remove
    
    Returns:
    
    IGraphQLMutation current object
  - getInputObject
```
public InputDataSenderBuilder getInputObject()
```
    Specified by:
    
    getInputObject in interface IGraphQLMutation
    
    Returns:
    
    InputDataSenderBuilder containing the details to update via the mutation
  - returnQuery
```
public String returnQuery()
```
    Description copied from interface: IGraphQLMutation
    
    Returns the full query to be passed to WWS, building the JSON object from the InputDataSenderBuilder and ObjectDataSenderBuilder
    
    Specified by:
    
    returnQuery in interface IGraphQLMutation
    
    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
  - getInputFieldsMap
```
public Map<String,Object> getInputFieldsMap()
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to InputDataSenderBuilder.getFieldsMap()
    
    Specified by:
    
    getInputFieldsMap in interface IGraphQLMutation
    
    Returns:
    
    Map of fields and values to set via the mutation
  - setInputFieldsMap
```
public void setInputFieldsMap(Map<String,Object> fieldsMap)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to InputDataSenderBuilder.setFieldsMap(Map)
    
    Specified by:
    
    setInputFieldsMap in interface IGraphQLMutation
    
    Parameters:
    
    fieldsMap - Map of fields and values to set via the mutation
  - addInputField
```
public InputDataSenderBuilder addInputField(String field,
                                            String value)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to InputDataSenderBuilder.addField(String, Object)
    
    Specified by:
    
    addInputField in interface IGraphQLMutation
    
    Parameters:
    
    field - String field name
    
    value - Object value to set
    
    Returns:
    
    InputDataSender, current object
  - addInputField
```
public InputDataSenderBuilder addInputField(WWFieldsAttributesInterface field,
                                            Object value)
                                     throws WWException
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to InputDataSenderBuilder.addField(WWFieldsAttributesInterface, Object)
    
    Specified by:
    
    addInputField in interface IGraphQLMutation
    
    Parameters:
    
    field - 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
  - removeInputField
```
public InputDataSenderBuilder removeInputField(String field)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to InputDataSenderBuilder.removeField(String)
    
    Specified by:
    
    removeInputField in interface IGraphQLMutation
    
    Parameters:
    
    field - String field name
    
    Returns:
    
    InputDataSender, current object
  - removeInputField
```
public InputDataSenderBuilder removeInputField(WWFieldsAttributesInterface field)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to InputDataSenderBuilder.removeField(WWFieldsAttributesInterface)
    
    Specified by:
    
    removeInputField in interface IGraphQLMutation
    
    Parameters:
    
    field - WWFieldsAttributesInterface enum, whose label property is the name of the field to set via the mutation
    
    Returns:
    
    InputDataSender, current object
  - getReturnObjectName
```
public String getReturnObjectName()
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.getObjectName()
    
    Specified by:
    
    getReturnObjectName in interface IGraphQLMutation
    
    Returns:
    
    String the objectName property from queryObject property
  - setReturnObjectName
```
public void setReturnObjectName(String objectName)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy to ObjectDataSenderBuilder.setObjectName(String)
    
    Specified by:
    
    setReturnObjectName in interface IGraphQLMutation
    
    Parameters:
    
    objectName - the objectName property from queryObject property
  - getReturnFieldsList
```
public List<String> getReturnFieldsList()
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.getFieldsList()
    
    Specified by:
    
    getReturnFieldsList in interface IGraphQLMutation
    
    Returns:
    
    List of String fields queryObject of this Query
  - setReturnFieldsList
```
public void setReturnFieldsList(List<String> fieldsList)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.setFieldsList(List)
    
    Specified by:
    
    setReturnFieldsList in interface IGraphQLMutation
    
    Parameters:
    
    fieldsList - List of String fields in the queryObject of this Query
  - addReturnField
```
public ObjectDataSenderBuilder addReturnField(String field)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addField(String)
    
    Specified by:
    
    addReturnField in interface IGraphQLMutation
    
    Parameters:
    
    field - String field to add to the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder queryObject of this Query
  - addReturnField
```
public ObjectDataSenderBuilder addReturnField(WWFieldsAttributesInterface field)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addField(WWFieldsAttributesInterface)
    
    Specified by:
    
    addReturnField in interface IGraphQLMutation
    
    Parameters:
    
    field - WWFIeldAttributesInterface field to add to the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder queryObject of this Query
  - removeReturnField
```
public ObjectDataSenderBuilder removeReturnField(String field)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.removeField(String)
    
    Specified by:
    
    removeReturnField in interface IGraphQLMutation
    
    Parameters:
    
    field - String field to remove from the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder queryObject of this Query
  - removeReturnField
```
public ObjectDataSenderBuilder removeReturnField(WWFieldsAttributesInterface field)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.removeField(WWFieldsAttributesInterface)
    
    Specified by:
    
    removeReturnField in interface IGraphQLMutation
    
    Parameters:
    
    field - WWFieldsAttributesInterface field to remove from the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder queryObject of this Query
  - getReturnChildren
```
public List<IDataSenderBuilder> getReturnChildren()
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.getChildren()
    
    Specified by:
    
    getReturnChildren in interface IGraphQLMutation
    
    Returns:
    
    List of IDataSenderBuilders corresponding to the children of the queryObject of this Query
  - setReturnChildren
```
public ObjectDataSenderBuilder setReturnChildren(List<IDataSenderBuilder> children)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.setChildren(List)
    
    Specified by:
    
    setReturnChildren in interface IGraphQLMutation
    
    Parameters:
    
    children - List of DataSenderBuilders corresponding to the children of the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder, the query object of this Query
  - addReturnChild
```
public ObjectDataSenderBuilder addReturnChild(IDataSenderBuilder child)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addChild(IDataSenderBuilder)
    
    Specified by:
    
    addReturnChild in interface IGraphQLMutation
    
    Parameters:
    
    child - DataSenderBuilder for the child to be added to the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder, the query object of this Query
  - removeReturnChild
```
public ObjectDataSenderBuilder removeReturnChild(IDataSenderBuilder child)
```
    Description copied from interface: IGraphQLMutation
    
    Helper method, to give easy access to ObjectDataSenderBuilder.removeChild(IDataSenderBuilder)
    
    Specified by:
    
    removeReturnChild in interface IGraphQLMutation
    
    Parameters:
    
    child - DataSenderBuilder for the child to be removed from the queryObject of this Query
    
    Returns:
    
    IDataSenderBuilder, the query object of this Query
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface IGraphQLMutation
    
    Overrides:
    
    hashCode in class Object

Class BaseGraphQLMutation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseGraphQLMutation

BaseGraphQLMutation

Method Detail

getOperationName

getReturnObjects

getFirstReturnObject

addReturnObject

removeReturnObject

getInputObject

returnQuery

getInputFieldsMap

setInputFieldsMap

addInputField

addInputField

removeInputField

removeInputField

getReturnObjectName

setReturnObjectName

getReturnFieldsList

setReturnFieldsList

addReturnField

addReturnField

removeReturnField

removeReturnField

getReturnChildren

setReturnChildren

addReturnChild

removeReturnChild

hashCode