IGraphQLQuery (Java SDK API Client 0.9.0-SNAPSHOT API)

All Known Implementing Classes:

BaseGraphQLMultiQuery, BaseGraphQLQuery, ConversationGraphQLQuery, MentionedGraphQLQuery, MessageGraphQLQuery, PeopleGraphQLQuery, PersonGraphQLQuery, SpaceGraphQLQuery, SpaceMembersGraphQLQuery, SpacesGraphQLQuery
```
public interface IGraphQLQuery
```
Since:

0.5.0 Interface for BaseGraphQLQuery and concrete classes from that

Author:

Paul Withers, Christian Guedemann

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ObjectDataSenderBuilder`	`addAttribute(String key, Object value)` Helper method, to give easy access to `ObjectDataSenderBuilder.addAttribute(String, Object)`
`ObjectDataSenderBuilder`	`addAttribute(WWFieldsAttributesInterface enumName, Object value)` Helper method, to give easy access to `ObjectDataSenderBuilder.addAttribute(WWFieldsAttributesInterface, Object)`
`ObjectDataSenderBuilder`	`addChild(IDataSenderBuilder child)` Helper method, to give easy access to `ObjectDataSenderBuilder.addChild(IDataSenderBuilder)`
`ObjectDataSenderBuilder`	`addField(String field)` Helper method, to give easy access to `ObjectDataSenderBuilder.addField(String)`
`ObjectDataSenderBuilder`	`addField(WWFieldsAttributesInterface field)` Helper method, to give easy access to `ObjectDataSenderBuilder.addField(WWFieldsAttributesInterface)`
`ObjectDataSenderBuilder`	`addPageInfo()` Helper method, to give easy access to `ObjectDataSenderBuilder.addPageInfo()`
`ObjectDataSenderBuilder`	`addPageInfo(ObjectDataSenderBuilder pageInfoCustom)` Helper method, to give easy access to `ObjectDataSenderBuilder.addPageInfo(ObjectDataSenderBuilder)`
`Map<String,Object>`	`getAttributesList()`
`List<IDataSenderBuilder>`	`getChildren()` Helper method, to give easy access to `ObjectDataSenderBuilder.getChildren()`
`List<String>`	`getFieldsList()` Helper method, to give easy access to `ObjectDataSenderBuilder.getFieldsList()`
`String`	`getObjectName()` Helper method, to give easy access to `ObjectDataSenderBuilder.getObjectName()`
`String`	`getOperationName()`
`ObjectDataSenderBuilder`	`getQueryObject()`
`boolean`	`isHasItems()` Helper method, to give easy access to `ObjectDataSenderBuilder.isHasItems()`
`ObjectDataSenderBuilder`	`removeAttribute(String key)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeAttribute(String)`
`ObjectDataSenderBuilder`	`removeAttribute(WWFieldsAttributesInterface enumName)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeAttribute(WWFieldsAttributesInterface)`
`ObjectDataSenderBuilder`	`removeChild(IDataSenderBuilder child)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeChild(IDataSenderBuilder)`
`ObjectDataSenderBuilder`	`removeField(String field)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeField(String)`
`ObjectDataSenderBuilder`	`removeField(WWFieldsAttributesInterface field)` Helper method, to give easy access to `ObjectDataSenderBuilder.removeField(WWFieldsAttributesInterface)`
`ObjectDataSenderBuilder`	`removePageInfo()` Helper method, to give easy access to `ObjectDataSenderBuilder.removePageInfo()`
`String`	`returnQuery()` Returns the full query to be passed to WWS, building the JSON object from an ObjectDataSenderBuilder
`ObjectDataSenderBuilder`	`setAttributesList(Map<String,Object> attributesList)` Helper method, to give easy access to `ObjectDataSenderBuilder.setAttributesList(Map)`
`ObjectDataSenderBuilder`	`setChildren(List<IDataSenderBuilder> children)` Helper method, to give easy access to `ObjectDataSenderBuilder.setChildren(List)`
`void`	`setFieldsList(List<String> fieldsList)` Helper method, to give easy access to `ObjectDataSenderBuilder.setFieldsList(List)`
`ObjectDataSenderBuilder`	`setHasItems(boolean hasItems)` Helper method, to give easy access to `ObjectDataSenderBuilder.setHasItems(boolean)`
`void`	`setObjectName(String objectName)` Helper method, to give easy to `ObjectDataSenderBuilder.setObjectName(String)`

- Method Detail
  - getOperationName
```
String getOperationName()
```
    Returns:
    
    String, operation name
    
    Since:
    
    0.5.0
  - getQueryObject
```
ObjectDataSenderBuilder getQueryObject()
```
    Returns:
    
    ObjectDataSenderBuilder containing the query settings
    
    Since:
    
    0.5.0
  - returnQuery
```
String returnQuery()
```
    Returns the full query to be passed to WWS, building the JSON object from an ObjectDataSenderBuilder
    
    Returns:
    
    String query to pass to WWS containing "query", the operation name, and a JSON object containing the query settings
    
    Since:
    
    0.5.0
  - getObjectName
```
String getObjectName()
```
    Helper method, to give easy access to ObjectDataSenderBuilder.getObjectName()
    
    Returns:
    
    String the objectName property from queryObject property
    
    Since:
    
    0.5.0
  - setObjectName
```
void setObjectName(String objectName)
```
    Helper method, to give easy to ObjectDataSenderBuilder.setObjectName(String)
    
    Parameters:
    
    objectName - the objectName property from queryObject property
    
    Since:
    
    0.5.0
  - isHasItems
```
boolean isHasItems()
```
    Helper method, to give easy access to ObjectDataSenderBuilder.isHasItems()
    
    Returns:
    
    boolean whether queryObject includes an items level in returned JSON
    
    Since:
    
    0.5.0
  - setHasItems
```
ObjectDataSenderBuilder setHasItems(boolean hasItems)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.setHasItems(boolean)
    
    Parameters:
    
    hasItems - whether queryObject includes an items level in returned JSON
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
    
    Since:
    
    0.5.0
  - getFieldsList
```
List<String> getFieldsList()
```
    Helper method, to give easy access to ObjectDataSenderBuilder.getFieldsList()
    
    Returns:
    
    List of String fields queryObject of this Query
    
    Since:
    
    0.5.0
  - setFieldsList
```
void setFieldsList(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.5.0
  - addField
```
ObjectDataSenderBuilder addField(String field)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.addField(String)
    
    Parameters:
    
    field - String field to add to the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
    
    Since:
    
    0.5.0
  - addField
```
ObjectDataSenderBuilder addField(WWFieldsAttributesInterface field)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.addField(WWFieldsAttributesInterface)
    
    Parameters:
    
    field - WWFIeldAttributesInterface field to add to the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
    
    Since:
    
    0.5.0
  - removeField
```
ObjectDataSenderBuilder removeField(String field)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.removeField(String)
    
    Parameters:
    
    field - String field to remove from the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
    
    Since:
    
    0.5.0
  - removeField
```
ObjectDataSenderBuilder removeField(WWFieldsAttributesInterface field)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.removeField(WWFieldsAttributesInterface)
    
    Parameters:
    
    field - WWFieldsAttributesInterface field to remove from the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
    
    Since:
    
    0.5.0
  - getAttributesList
```
Map<String,Object> getAttributesList()
```
    Returns:
    
    Map of attributes used to filter this Query, retrieved from the queryObject
    
    Since:
    
    0.5.0
  - setAttributesList
```
ObjectDataSenderBuilder setAttributesList(Map<String,Object> attributesList)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.setAttributesList(Map)
    
    Parameters:
    
    attributesList - Map of attributes used to filter the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of the queryObject of this Query
    
    Since:
    
    0.5.0
  - addAttribute
```
ObjectDataSenderBuilder addAttribute(String key,
                                     Object value)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.addAttribute(String, Object)
    
    Parameters:
    
    key - String, attribute name to filter the queryObject of this Query
    
    value - Object, value to filter the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the queryObject object of this Query
    
    Since:
    
    0.5.0
  - addAttribute
```
ObjectDataSenderBuilder addAttribute(WWFieldsAttributesInterface enumName,
                                     Object value)
                              throws WWException
```
    Helper method, to give easy access to ObjectDataSenderBuilder.addAttribute(WWFieldsAttributesInterface, Object)
    
    Parameters:
    
    enumName - enum, from which label property will give attribute name to filter the queryObject of this Query
    
    value - Object, value to filter the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the queryObject object of this Query
    
    Throws:
    
    WWException - containing an error message, if the value is a different data type to what the enum expects
    
    Since:
    
    0.5.0
  - removeAttribute
```
ObjectDataSenderBuilder removeAttribute(String key)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.removeAttribute(String)
    
    Parameters:
    
    key - String, attribute name to filter the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the queryObject object of this Query
    
    Since:
    
    0.5.0
  - removeAttribute
```
ObjectDataSenderBuilder removeAttribute(WWFieldsAttributesInterface enumName)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.removeAttribute(WWFieldsAttributesInterface)
    
    Parameters:
    
    enumName - enum, from which label property will give attribute name to filter the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the queryObject object of this Query
    
    Since:
    
    0.5.0
  - getChildren
```
List<IDataSenderBuilder> getChildren()
```
    Helper method, to give easy access to ObjectDataSenderBuilder.getChildren()
    
    Returns:
    
    List of DataSenderBuilders corresponding to the children of the queryObject of this Query
    
    Since:
    
    0.5.0
  - setChildren
```
ObjectDataSenderBuilder setChildren(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:
    
    ObjectDataSenderBuilder, the query object of this Query
    
    Since:
    
    0.5.0
  - addChild
```
ObjectDataSenderBuilder addChild(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:
    
    ObjectDataSenderBuilder, the query object of this Query
    
    Since:
    
    0.5.0
  - removeChild
```
ObjectDataSenderBuilder removeChild(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:
    
    ObjectDataSenderBuilder, the query object of this Query
    
    Since:
    
    0.5.0
  - addPageInfo
```
ObjectDataSenderBuilder addPageInfo()
```
    Helper method, to give easy access to ObjectDataSenderBuilder.addPageInfo()
    
    Returns:
    
    ObjectDataSenderBuilder, the query object of this Query
    
    Since:
    
    0.5.0
  - addPageInfo
```
ObjectDataSenderBuilder addPageInfo(ObjectDataSenderBuilder pageInfoCustom)
```
    Helper method, to give easy access to ObjectDataSenderBuilder.addPageInfo(ObjectDataSenderBuilder)
    
    Parameters:
    
    pageInfoCustom - ObjectDataSenderBuilder containing the custom pageInfo fields to return from the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the query object of this Query
    
    Since:
    
    0.5.0
  - removePageInfo
```
ObjectDataSenderBuilder removePageInfo()
```
    Helper method, to give easy access to ObjectDataSenderBuilder.removePageInfo()
    
    Returns:
    
    ObjectDataSenderBuilder, the query object of this Query
    
    Since:
    
    0.5.0

Interface IGraphQLQuery

Method Summary

Method Detail

getOperationName

getQueryObject

returnQuery

getObjectName

setObjectName

isHasItems

setHasItems

getFieldsList

setFieldsList

addField

addField

removeField

removeField

getAttributesList

setAttributesList

addAttribute

addAttribute

removeAttribute

removeAttribute

getChildren

setChildren

addChild

removeChild

addPageInfo

addPageInfo

removePageInfo