ObjectDataSenderBuilder (Java SDK API Client 0.9.0-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, IDataSenderBuilder

Direct Known Subclasses:

BasicCreatedByUpdatedByDataSenderBuilder
```
public class ObjectDataSenderBuilder
extends Object
implements IDataSenderBuilder, Serializable
```
Since:

0.5.0 DataSender for sending GraphQL query objects. The object will have a name, may have attributes (parameter to filter the query), fields and/or children to return. Each child will be an ObjectDataSenderBuilder of its own. Consult WWS Graph QL Builder for details of what attributes etc at https://workspace.ibm.com/graphql

Author:

Paul Withers, Christian Guedemann

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ObjectDataSenderBuilder()` Raw constructor.
`ObjectDataSenderBuilder(String objectName)` Base constructor, defining the object name.
`ObjectDataSenderBuilder(String objectName, boolean hasItems)` Base constructor, defining the object name and specifying whether fields / children are in an items object
`ObjectDataSenderBuilder(String objectName, boolean hasItems, WWFieldsAttributesInterface[] fieldsEnum)` Constructor, defining the object name and whether fields should be wrapped in an items object.
`ObjectDataSenderBuilder(String objectName, Class<?> clazz, Boolean hasItems)` Constructor, defining the object name, specifying whether fields are in an items object.
`ObjectDataSenderBuilder(String objectName, WWFieldsAttributesInterface[] fieldsEnum)` Constructor, defining the object name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectDataSenderBuilder`	`addAttribute(String key, Object value)` Add an attribute by which to filter the request
`ObjectDataSenderBuilder`	`addAttribute(WWFieldsAttributesInterface enumName, Object value)` Add an attribute by which to filter the request
`ObjectDataSenderBuilder`	`addChild(IDataSenderBuilder child)` Add a request for a specific child from the object
`ObjectDataSenderBuilder`	`addField(String field)` Add a field to return from the object
`ObjectDataSenderBuilder`	`addField(WWFieldsAttributesInterface field)` Add a field to request from the object
`ObjectDataSenderBuilder`	`addPageInfo()` Adds a query to retrieve the full, default PageInfo object
`ObjectDataSenderBuilder`	`addPageInfo(ObjectDataSenderBuilder pageInfoCustom)` Adds a query to retrieve a custom set of PageInfo
`String`	`build()` Builds the JSON stream to send.
`String`	`build(boolean pretty)` Builds the JSON stream to send, optionally adding pretty styling
`Map<String,Object>`	`getAttributesList()`
`List<IDataSenderBuilder>`	`getChildren()`
`List<String>`	`getFieldsList()`
`String`	`getObjectForQuery()` If a return type has been defined, we need to return objectName:returnTypeForQuery e.g.
`String`	`getObjectName()`
`WWQueryResponseObjectInterface`	`getReturnType()` Get enum containing class response needs casting to
`boolean`	`isHasAlias()`
`boolean`	`isHasItems()`
`ObjectDataSenderBuilder`	`removeAttribute(String key)` Remove an attribute from the request
`ObjectDataSenderBuilder`	`removeAttribute(WWFieldsAttributesInterface enumName)` Remove an attribute from the request
`ObjectDataSenderBuilder`	`removeChild(IDataSenderBuilder child)` Removes a request for a specific child from the object
`ObjectDataSenderBuilder`	`removeField(String field)` Removes a field to request from the object
`ObjectDataSenderBuilder`	`removeField(WWFieldsAttributesInterface field)` Removes a field to request from the object
`ObjectDataSenderBuilder`	`removePageInfo()` Remove the request for PageInfo from this object
`ObjectDataSenderBuilder`	`setAttributesList(Map<String,Object> attributesList)` Adds a map of attributes by which the filter the request
`ObjectDataSenderBuilder`	`setChildren(List<IDataSenderBuilder> children)`
`void`	`setFieldsList(List<String> fieldsList)`
`void`	`setHasAlias(boolean hasAlias)`
`ObjectDataSenderBuilder`	`setHasItems(boolean hasItems)` Defines whether the object's properties are wrapped in an items container
`void`	`setObjectName(String objectName)`
`void`	`setReturnType(WWQueryResponseObjectInterface returnType)` When using an alias, we need to capture class to case return to

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

- Constructor Detail
  - ObjectDataSenderBuilder
```
public ObjectDataSenderBuilder()
```
    Raw constructor. Recommendation is to use overloaded methods
  - ObjectDataSenderBuilder
```
public ObjectDataSenderBuilder(String objectName)
```
    Base constructor, defining the object name. Sets hasItems = false.
    
    Parameters:
    
    objectName - String name of the object, used in the query. Consult WWS GraphQL Builder for details
    
    Since:
    
    0.5.0
  - ObjectDataSenderBuilder
```
public ObjectDataSenderBuilder(String objectName,
                               boolean hasItems)
```
    Base constructor, defining the object name and specifying whether fields / children are in an items object
    
    Parameters:
    
    objectName - String name of the object, used in the query. Consult WWS GraphQL Builder for details
    
    hasItems - boolean whether the fields / children are wrapped in "items{}"
    
    Since:
    
    0.5.0
  - ObjectDataSenderBuilder
```
public ObjectDataSenderBuilder(String objectName,
                               Class<?> clazz,
                               Boolean hasItems)
```
    Constructor, defining the object name, specifying whether fields are in an items object. All fields are then added using the properties of the class passed. NOTE: this will not work for classes that are intended to contain children, only scalar field values.
    
    Parameters:
    
    objectName - String name of the object, used in the query. Consult WWS GraphQL Builder for details
    
    clazz - Class from which to add all fields
    
    hasItems - boolean whether the fields / children are wrapped in "items{}"
    
    Since:
    
    0.5.0
  - ObjectDataSenderBuilder
```
public ObjectDataSenderBuilder(String objectName,
                               WWFieldsAttributesInterface[] fieldsEnum)
```
    Constructor, defining the object name. All fields are then added using the enum passed. Children can then be added subsequently. isHasItems() will be false
    
    Parameters:
    
    objectName - String name of the object, used in the query. Consult WWS GraphQL Builder for details
    
    fieldsEnum - Enum of fields, all of which will be added
    
    Since:
    
    0.5.0
  - ObjectDataSenderBuilder
```
public ObjectDataSenderBuilder(String objectName,
                               boolean hasItems,
                               WWFieldsAttributesInterface[] fieldsEnum)
```
    Constructor, defining the object name and whether fields should be wrapped in an items object. All fields are then added using the enum passed. Children can then be added subsequently.
    
    Parameters:
    
    objectName - String name of the object, used in the query. Consult WWS GraphQL Builder for details
    
    hasItems - boolean whether the fields / children are wrapped in "items{}"
    
    fieldsEnum - Enum of fields, all of which will be added
    
    Since:
    
    0.5.0
- Method Detail
  - setReturnType
```
public void setReturnType(WWQueryResponseObjectInterface returnType)
```
    When using an alias, we need to capture class to case return to
    
    Parameters:
    
    returnType - Class of return object
  - getReturnType
```
public WWQueryResponseObjectInterface getReturnType()
```
    Get enum containing class response needs casting to
    
    Returns:
    
    WWQueryResponseObjectInterface corresponding to the class the response needs casting to
  - build
```
public String build()
```
    Description copied from interface: IDataSenderBuilder
    
    Builds the JSON stream to send. Calls IDataSenderBuilder.build(boolean), passing false
    
    Specified by:
    
    build in interface IDataSenderBuilder
    
    Returns:
    
    String, JSON data
  - build
```
public String build(boolean pretty)
```
    Description copied from interface: IDataSenderBuilder
    
    Builds the JSON stream to send, optionally adding pretty styling
    
    Specified by:
    
    build in interface IDataSenderBuilder
    
    Parameters:
    
    pretty - boolean whether or not to output in a more readable format
    
    Returns:
    
    String, JSON data
  - getObjectName
```
public String getObjectName()
```
    Returns:
    
    String, name of the query object
    
    Since:
    
    0.5.0
  - getObjectForQuery
```
public String getObjectForQuery()
```
    If a return type has been defined, we need to return objectName:returnTypeForQuery e.g. space1:space. Otherwise, we just need objectName, e.g. space
    
    Returns:
    
    String, prefix for the query
  - setObjectName
```
public void setObjectName(String objectName)
```
    Parameters:
    
    objectName - String, name of the query object
    
    Since:
    
    0.5.0
  - isHasItems
```
public boolean isHasItems()
```
    Returns:
    
    boolean, whether the object's properties are wrapped in an items container
    
    Since:
    
    0.5.0
  - setHasItems
```
public ObjectDataSenderBuilder setHasItems(boolean hasItems)
```
    Defines whether the object's properties are wrapped in an items container
    
    Parameters:
    
    hasItems - boolean, whether the object's fields and children are wrapped in an items container
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - getFieldsList
```
public List<String> getFieldsList()
```
    Returns:
    
    List of string fields to return
    
    Since:
    
    0.5.0
  - setFieldsList
```
public void setFieldsList(List<String> fieldsList)
```
    Parameters:
    
    fieldsList - List of string fields to return
    
    Since:
    
    0.5.0
  - addField
```
public ObjectDataSenderBuilder addField(String field)
```
    Add a field to return from the object
    
    Parameters:
    
    field - String, name of the field to add
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - addField
```
public ObjectDataSenderBuilder addField(WWFieldsAttributesInterface field)
```
    Add a field to request from the object
    
    Parameters:
    
    field - WWFieldsAttributesInterface enum, whose label property is the name of the field to add
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - removeField
```
public ObjectDataSenderBuilder removeField(String field)
```
    Removes a field to request from the object
    
    Parameters:
    
    field - String, name of the field to remove
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - removeField
```
public ObjectDataSenderBuilder removeField(WWFieldsAttributesInterface field)
```
    Removes a field to request from the object
    
    Parameters:
    
    field - String, WWFieldsAttributesInterface field to remove
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - getAttributesList
```
public Map<String,Object> getAttributesList()
```
    Returns:
    
    Map of attributes to filter the request on. The key will be the attribute name, the value will be the value to filter against
    
    Since:
    
    0.5.0
  - setAttributesList
```
public ObjectDataSenderBuilder setAttributesList(Map<String,Object> attributesList)
```
    Adds a map of attributes by which the filter the request
    
    Parameters:
    
    attributesList - Map of attributes to filter the request on. The key will be the attribute name, the value will be the value to filter against
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - addAttribute
```
public ObjectDataSenderBuilder addAttribute(String key,
                                            Object value)
```
    Add an attribute by which to filter the request
    
    Parameters:
    
    key - String, attribute name to filter on
    
    value - Object, value to filter on
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - addAttribute
```
public ObjectDataSenderBuilder addAttribute(WWFieldsAttributesInterface enumName,
                                            Object value)
                                     throws WWException
```
    Add an attribute by which to filter the request
    
    Parameters:
    
    enumName - enum, from which label property will give attribute name to filter on
    
    value - Object, value to filter on
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Throws:
    
    WWException - containing an error message, if the value is a different data type to what the enum expects
    
    Since:
    
    0.5.0
  - removeAttribute
```
public ObjectDataSenderBuilder removeAttribute(String key)
```
    Remove an attribute from the request
    
    Parameters:
    
    key - String, attribute to remove from the request
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - removeAttribute
```
public ObjectDataSenderBuilder removeAttribute(WWFieldsAttributesInterface enumName)
```
    Remove an attribute from the request
    
    Parameters:
    
    enumName - enum, from which label property will give attribute name to filter on
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - getChildren
```
public List<IDataSenderBuilder> getChildren()
```
    Returns:
    
    List of IDataSenderBuilder children to request from the object
    
    Since:
    
    0.5.0
  - setChildren
```
public ObjectDataSenderBuilder setChildren(List<IDataSenderBuilder> children)
```
    Parameters:
    
    children - List of IDataSenderBuilder children to request from the object
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - addChild
```
public ObjectDataSenderBuilder addChild(IDataSenderBuilder child)
```
    Add a request for a specific child from the object
    
    Parameters:
    
    child - DataSenderBuilder, child to add
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - removeChild
```
public ObjectDataSenderBuilder removeChild(IDataSenderBuilder child)
```
    Removes a request for a specific child from the object
    
    Parameters:
    
    child - DataSenderBuilder, child to remove
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - addPageInfo
```
public ObjectDataSenderBuilder addPageInfo()
```
    Adds a query to retrieve the full, default PageInfo object
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - addPageInfo
```
public ObjectDataSenderBuilder addPageInfo(ObjectDataSenderBuilder pageInfoCustom)
```
    Adds a query to retrieve a custom set of PageInfo
    
    Parameters:
    
    pageInfoCustom - ObjectDataSenderBuilder containing the PageInfo fields to return
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - removePageInfo
```
public ObjectDataSenderBuilder removePageInfo()
```
    Remove the request for PageInfo from this object
    
    Returns:
    
    ObjectDataSenderBuilder, current object
    
    Since:
    
    0.5.0
  - isHasAlias
```
public boolean isHasAlias()
```
  - setHasAlias
```
public void setHasAlias(boolean hasAlias)
```

Class ObjectDataSenderBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ObjectDataSenderBuilder

ObjectDataSenderBuilder

ObjectDataSenderBuilder

ObjectDataSenderBuilder

ObjectDataSenderBuilder

ObjectDataSenderBuilder

Method Detail

setReturnType

getReturnType

build

build

getObjectName

getObjectForQuery

setObjectName

isHasItems

setHasItems

getFieldsList

setFieldsList

addField

addField

removeField

removeField

getAttributesList

setAttributesList

addAttribute

addAttribute

removeAttribute

removeAttribute

getChildren

setChildren

addChild

removeChild

addPageInfo

addPageInfo

removePageInfo

isHasAlias

setHasAlias