com.daikit.graphql.meta

Annotation Type GQLAttribute

@Target(value={FIELD,TYPE})
 @Retention(value=RUNTIME)
public @interface GQLAttribute

Annotation for entity attribute or dynamic attribute class for customizing CRUD, nullable and filtering

Version:

$Revision$ Last modifier: $Author$ Last commit: $Date$

Author:

tcaselli

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description The description that will be generated for this attribute in the GraphQL schema.
boolean	exclude Get whether this attribute is excluded from transport to client.
boolean	filter Get whether this attribute can be used as a filter property by client.
String	name Provide a value here in order to change the name under which the annotated attribute will be accessible in the API.
GQLAttributeRights[]	rights Rights for annotated attribute

Element Detail

description

public abstract String description

The description that will be generated for this attribute in the GraphQL schema.

Returns:

the attribute description

Default:

""

name

public abstract String name

Provide a value here in order to change the name under which the annotated attribute will be accessible in the API. If empty or null then the annotated attribute name will be used.

Returns:

the attribute name

Default:

""

exclude

public abstract boolean exclude

Get whether this attribute is excluded from transport to client. This is a shortcut for "rights = @GQLAttributeRights(exclude = true)". If this is true then rights are ignored.

Returns:

a boolean (false by default)

Default:

false

filter

public abstract boolean filter

Get whether this attribute can be used as a filter property by client.

Returns:

a boolean (true by default)

Default:

true

rights

public abstract GQLAttributeRights[] rights

Rights for annotated attribute

Returns:

an array of GQLAttributeRights

Default:

{}