org.opencode4workspace.builders

Class PeopleGraphQLQuery

java.lang.Object

org.opencode4workspace.builders.BaseGraphQLQuery

org.opencode4workspace.builders.PeopleGraphQLQuery

All Implemented Interfaces:

Serializable, IGraphQLQuery

public class PeopleGraphQLQuery
extends BaseGraphQLQuery

Since:

0.5.0 Object for creating Me or Person query

Author:

Paul Withers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PeopleGraphQLQuery.PeopleAttributes

Constructor Summary

Constructors

Constructor and Description
PeopleGraphQLQuery() Creates a People query with a blank ObjectDataSenderBuilder query object
PeopleGraphQLQuery(ObjectDataSenderBuilder query) Creates a People query with a pre-populated ObjectDataSenderBuilder query object
PeopleGraphQLQuery(String operationName, ObjectDataSenderBuilder query) Creates a People query with a passed operation name and pre-populated ObjectDataSenderBuilder query object

Method Summary

Modifier and Type	Method and Description
static PeopleGraphQLQuery	buildPersonQueryById(List<String> personId) Builds a People query based on a List of IDs of person entries
static PeopleGraphQLQuery	buildPersonQueryByName(String personName) Builds a People query based on a word in a person's name

Methods inherited from class org.opencode4workspace.builders.BaseGraphQLQuery

addAttribute, addAttribute, addChild, addField, addField, addPageInfo, addPageInfo, getAttributesList, getChildren, getFieldsList, getObjectName, getOperationName, getQueryObject, hashCode, isHasItems, removeAttribute, removeAttribute, removeChild, removeField, removeField, removePageInfo, returnQuery, setAttributesList, setChildren, setFieldsList, setHasItems, setObjectName

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeopleGraphQLQuery

public PeopleGraphQLQuery()

Creates a People query with a blank ObjectDataSenderBuilder query object

Since:

0.5.0

PeopleGraphQLQuery

public PeopleGraphQLQuery(ObjectDataSenderBuilder query)

Creates a People query with a pre-populated ObjectDataSenderBuilder query object

Parameters:

query - ObjectDataSenderBuilder containing query options

Since:

0.5.0

PeopleGraphQLQuery

public PeopleGraphQLQuery(String operationName,
                          ObjectDataSenderBuilder query)

Creates a People query with a passed operation name and pre-populated ObjectDataSenderBuilder query object

Parameters:

operationName - String operation name, e.g. METHOD

query - ObjectDataSenderBuilder containing the query settings

Since:

0.5.0

Method Detail

buildPersonQueryById

public static PeopleGraphQLQuery buildPersonQueryById(List<String> personId)
                                               throws WWException

Builds a People query based on a List of IDs of person entries

Parameters:

personId - List of String person IDs

Returns:

PeopleGraphQLQuery of basic unfiltered person fields and children

Throws:

WWException - containing an error message, if the request was unsuccessful

Since:

0.5.0

buildPersonQueryByName

public static PeopleGraphQLQuery buildPersonQueryByName(String personName)
                                                 throws WWException

Builds a People query based on a word in a person's name

Parameters:

personName - String, part of a person's name

Returns:

PeopleGraphQLQuery of basic unfiltered person fields and children

Throws:

WWException - containing an error message, if the request was unsuccessful

Since:

0.5.0