org.opencode4workspace.endpoints

Interface IWWGraphQLEndpoint

All Known Implementing Classes:

AbstractWWGraphQLEndpoint, FilePostToSpaceEndpoint, FocusPostEndpoint, MessagePostEndpoint, PhotoPostEndpoint, WWGraphQLEndpoint

public interface IWWGraphQLEndpoint

Since:

0.5.0 Interface for Graph Query endpoints

Author:

Paul Withers

Method Summary

Modifier and Type	Method and Description
void	executeRequest() Runs the main code to execute the GraphQL request on Watson Work Services.
IWWClient	getClient()
Boolean	getProfileDump()
GraphQLRequest	getRequest()
GraphResultContainer	getResultContainer()
String	getResultContent()
Object	parseResultContainer() Parses the ResultContainer to return the relevant Java object of results.
void	setProfileDump(Boolean profileDump)
void	setRequest(GraphQLRequest request)
void	setResultContainer(GraphResultContainer resultContainer)
void	setResultContent(String resultContent)

Method Detail

getClient

IWWClient getClient()

Returns:

WWClient passed into constructor

Since:

0.5.0

getRequest

GraphQLRequest getRequest()

Returns:

GraphQLRequest, request details to be passed to the endpoint

Since:

0.5.0

setRequest

void setRequest(GraphQLRequest request)

Parameters:

request - GraphQLRequest, request details to be passed to the endpoint

Since:

0.5.0

getResultContainer

GraphResultContainer getResultContainer()

Returns:

GraphResultContainer generated by a successful executeRequest()

Since:

0.5.0

setResultContainer

void setResultContainer(GraphResultContainer resultContainer)

Parameters:

resultContainer - GraphResultContainer generated by a successful executeRequest(). Should not need overloading, but just in case, this method is still exposed

Since:

0.5.0

executeRequest

void executeRequest()
             throws WWException

Runs the main code to execute the GraphQL request on Watson Work Services. setRequest(GraphQLRequest) must be called before calling this method. This method should not need overloading.

Throws:

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

Since:

0.5.0

parseResultContainer

Object parseResultContainer()
                     throws WWException

Parses the ResultContainer to return the relevant Java object of results. This method should be overloaded by any implementation.

Returns:

Object containing the contents of the result

Throws:

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

Since:

0.5.0

getResultContent

String getResultContent()

Returns:

String raw JSON results as String

Since:

0.5.0

setResultContent

void setResultContent(String resultContent)

Parameters:

resultContent - String raw JSON results as string

Since:

0.5.0

getProfileDump

Boolean getProfileDump()

Returns:

Boolean whether or not to dump profile data of query and response time

Since:

0.5.0

setProfileDump

void setProfileDump(Boolean profileDump)

Parameters:

profileDump - Boolean whether or not to dump profile data of query and response time

Since:

0.5.0