BaseGraphQLQuery (Java SDK API Client 0.9.0-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, IGraphQLQuery

Direct Known Subclasses:

BaseGraphQLMultiQuery, ConversationGraphQLQuery, MentionedGraphQLQuery, MessageGraphQLQuery, PeopleGraphQLQuery, PersonGraphQLQuery, SpaceGraphQLQuery, SpaceMembersGraphQLQuery, SpacesGraphQLQuery
```
public abstract class BaseGraphQLQuery
extends Object
implements Serializable, IGraphQLQuery
```
Since:

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

Author:

Paul Withers, Christian Gudemann

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`BaseGraphQLQuery(String operationName, ObjectDataSenderBuilder queryObject)` Constructor, passing in everything required to build the query

Method Summary

All Methods Instance Methods Concrete 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()`
`int`	`hashCode()`
`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)`

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

- Constructor Detail
  - BaseGraphQLQuery
```
public BaseGraphQLQuery(String operationName,
                        ObjectDataSenderBuilder queryObject)
```
    Constructor, passing in everything required to build the query
    
    Parameters:
    
    operationName - String, operation name
    
    queryObject - ObjectDataSenderBuilder containing the query settings
- Method Detail
  - getOperationName
```
public String getOperationName()
```
    Specified by:
    
    getOperationName in interface IGraphQLQuery
    
    Returns:
    
    String, operation name
  - getQueryObject
```
public ObjectDataSenderBuilder getQueryObject()
```
    Specified by:
    
    getQueryObject in interface IGraphQLQuery
    
    Returns:
    
    ObjectDataSenderBuilder containing the query settings
  - returnQuery
```
public String returnQuery()
```
    Description copied from interface: IGraphQLQuery
    
    Returns the full query to be passed to WWS, building the JSON object from an ObjectDataSenderBuilder
    
    Specified by:
    
    returnQuery in interface IGraphQLQuery
    
    Returns:
    
    String query to pass to WWS containing "query", the operation name, and a JSON object containing the query settings
  - getObjectName
```
public String getObjectName()
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.getObjectName()
    
    Specified by:
    
    getObjectName in interface IGraphQLQuery
    
    Returns:
    
    String the objectName property from queryObject property
  - setObjectName
```
public void setObjectName(String objectName)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy to ObjectDataSenderBuilder.setObjectName(String)
    
    Specified by:
    
    setObjectName in interface IGraphQLQuery
    
    Parameters:
    
    objectName - the objectName property from queryObject property
  - isHasItems
```
public boolean isHasItems()
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.isHasItems()
    
    Specified by:
    
    isHasItems in interface IGraphQLQuery
    
    Returns:
    
    boolean whether queryObject includes an items level in returned JSON
  - setHasItems
```
public ObjectDataSenderBuilder setHasItems(boolean hasItems)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.setHasItems(boolean)
    
    Specified by:
    
    setHasItems in interface IGraphQLQuery
    
    Parameters:
    
    hasItems - whether queryObject includes an items level in returned JSON
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
  - getFieldsList
```
public List<String> getFieldsList()
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.getFieldsList()
    
    Specified by:
    
    getFieldsList in interface IGraphQLQuery
    
    Returns:
    
    List of String fields queryObject of this Query
  - setFieldsList
```
public void setFieldsList(List<String> fieldsList)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.setFieldsList(List)
    
    Specified by:
    
    setFieldsList in interface IGraphQLQuery
    
    Parameters:
    
    fieldsList - List of String fields in the queryObject of this Query
  - addField
```
public ObjectDataSenderBuilder addField(String field)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addField(String)
    
    Specified by:
    
    addField in interface IGraphQLQuery
    
    Parameters:
    
    field - String field to add to the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
  - addField
```
public ObjectDataSenderBuilder addField(WWFieldsAttributesInterface field)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addField(WWFieldsAttributesInterface)
    
    Specified by:
    
    addField in interface IGraphQLQuery
    
    Parameters:
    
    field - WWFIeldAttributesInterface field to add to the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
  - removeField
```
public ObjectDataSenderBuilder removeField(String field)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.removeField(String)
    
    Specified by:
    
    removeField in interface IGraphQLQuery
    
    Parameters:
    
    field - String field to remove from the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
  - removeField
```
public ObjectDataSenderBuilder removeField(WWFieldsAttributesInterface field)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.removeField(WWFieldsAttributesInterface)
    
    Specified by:
    
    removeField in interface IGraphQLQuery
    
    Parameters:
    
    field - WWFieldsAttributesInterface field to remove from the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of this Query
  - getAttributesList
```
public Map<String,Object> getAttributesList()
```
    Specified by:
    
    getAttributesList in interface IGraphQLQuery
    
    Returns:
    
    Map of attributes used to filter this Query, retrieved from the queryObject
  - setAttributesList
```
public ObjectDataSenderBuilder setAttributesList(Map<String,Object> attributesList)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.setAttributesList(Map)
    
    Specified by:
    
    setAttributesList in interface IGraphQLQuery
    
    Parameters:
    
    attributesList - Map of attributes used to filter the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder queryObject of the queryObject of this Query
  - addAttribute
```
public ObjectDataSenderBuilder addAttribute(String key,
                                            Object value)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addAttribute(String, Object)
    
    Specified by:
    
    addAttribute in interface IGraphQLQuery
    
    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
  - addAttribute
```
public ObjectDataSenderBuilder addAttribute(WWFieldsAttributesInterface enumName,
                                            Object value)
                                     throws WWException
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addAttribute(WWFieldsAttributesInterface, Object)
    
    Specified by:
    
    addAttribute in interface IGraphQLQuery
    
    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
  - removeAttribute
```
public ObjectDataSenderBuilder removeAttribute(String key)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.removeAttribute(String)
    
    Specified by:
    
    removeAttribute in interface IGraphQLQuery
    
    Parameters:
    
    key - String, attribute name to filter the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the queryObject object of this Query
  - removeAttribute
```
public ObjectDataSenderBuilder removeAttribute(WWFieldsAttributesInterface enumName)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.removeAttribute(WWFieldsAttributesInterface)
    
    Specified by:
    
    removeAttribute in interface IGraphQLQuery
    
    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
  - getChildren
```
public List<IDataSenderBuilder> getChildren()
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.getChildren()
    
    Specified by:
    
    getChildren in interface IGraphQLQuery
    
    Returns:
    
    List of DataSenderBuilders corresponding to the children of the queryObject of this Query
  - setChildren
```
public ObjectDataSenderBuilder setChildren(List<IDataSenderBuilder> children)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.setChildren(List)
    
    Specified by:
    
    setChildren in interface IGraphQLQuery
    
    Parameters:
    
    children - List of DataSenderBuilders corresponding to the children of the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the query object of this Query
  - addChild
```
public ObjectDataSenderBuilder addChild(IDataSenderBuilder child)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addChild(IDataSenderBuilder)
    
    Specified by:
    
    addChild in interface IGraphQLQuery
    
    Parameters:
    
    child - DataSenderBuilder for the child to be added to the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the query object of this Query
  - removeChild
```
public ObjectDataSenderBuilder removeChild(IDataSenderBuilder child)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.removeChild(IDataSenderBuilder)
    
    Specified by:
    
    removeChild in interface IGraphQLQuery
    
    Parameters:
    
    child - DataSenderBuilder for the child to be removed from the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the query object of this Query
  - addPageInfo
```
public ObjectDataSenderBuilder addPageInfo()
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addPageInfo()
    
    Specified by:
    
    addPageInfo in interface IGraphQLQuery
    
    Returns:
    
    ObjectDataSenderBuilder, the query object of this Query
  - addPageInfo
```
public ObjectDataSenderBuilder addPageInfo(ObjectDataSenderBuilder pageInfoCustom)
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.addPageInfo(ObjectDataSenderBuilder)
    
    Specified by:
    
    addPageInfo in interface IGraphQLQuery
    
    Parameters:
    
    pageInfoCustom - ObjectDataSenderBuilder containing the custom pageInfo fields to return from the queryObject of this Query
    
    Returns:
    
    ObjectDataSenderBuilder, the query object of this Query
  - removePageInfo
```
public ObjectDataSenderBuilder removePageInfo()
```
    Description copied from interface: IGraphQLQuery
    
    Helper method, to give easy access to ObjectDataSenderBuilder.removePageInfo()
    
    Specified by:
    
    removePageInfo in interface IGraphQLQuery
    
    Returns:
    
    ObjectDataSenderBuilder, the query object of this Query
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class BaseGraphQLQuery

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseGraphQLQuery

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

hashCode