GraphQLPaginationResponseHandler (GORM GraphQL - 4.0.0-SNAPSHOT)

Summary:
Method

| Detail:
Method

```
interface GraphQLPaginationResponseHandler
```
Defines how a pagination response is defined and built
Authors:
James Kleeh
Since:
1.0.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`abstract java.lang.Object`	`createResponse(graphql.schema.DataFetchingEnvironment environment, PaginationResult result)` Create the response data to be sent to the client
	`abstract int`	`getDefaultMax()` Returns: The default maximum value if none provided
	`abstract int`	`getDefaultOffset()` Returns: The default offset value if none provided
	`abstract java.lang.String`	`getDescription(org.grails.datastore.mapping.model.PersistentEntity entity)` Returns: The description to use in the schema, or null
	`abstract java.util.List<graphql.schema.GraphQLFieldDefinition>`	`getFields(graphql.schema.GraphQLOutputType resultsType, GraphQLTypeManager typeManager)` Creates the fields to be used in the schema object for a pagination response

- Method Detail
  - abstract java.lang.Object createResponse(graphql.schema.DataFetchingEnvironment environment, PaginationResult result)
    
    Create the response data to be sent to the client
    Parameters:
    environment - The data fetching environment
    results - The data retrieved from the query
    Returns:
    Response data
  - abstract int getDefaultMax()
    
    Returns:
    The default maximum value if none provided
  - abstract int getDefaultOffset()
    
    Returns:
    The default offset value if none provided
  - abstract java.lang.String getDescription(org.grails.datastore.mapping.model.PersistentEntity entity)
    
    Returns:
    The description to use in the schema, or null
  - abstract java.util.List<graphql.schema.GraphQLFieldDefinition> getFields(graphql.schema.GraphQLOutputType resultsType, GraphQLTypeManager typeManager)
    
    Creates the fields to be used in the schema object for a pagination response
    Parameters:
    resultsType - The graphql type of the results
    typeManager - The type manager
    Returns:
    The GraphQL type

Summary:
Method

| Detail:
Method

Groovy Documentation