com.daikit.graphql.meta

Annotation Type GQLEntity

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface GQLEntity

Annotation for entity attribute for customizing CRUD

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 entity in the GraphQL schema.
boolean	exclude Get whether this entity is excluded from transport to client (if true it is equivalent to read==false AND save==false AND delete==false AND filter==false).
String	name Provide a value here in order to change the name under which the annotated entity class will be accessible in the API.
GQLEntityRights[]	rights Rights for annotated entity

Element Detail

description

public abstract String description

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

Returns:

the entity description

Default:

""

name

public abstract String name

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

Returns:

the entity name

Default:

""

exclude

public abstract boolean exclude

Get whether this entity is excluded from transport to client (if true it is equivalent to read==false AND save==false AND delete==false AND filter==false).

Returns:

a boolean (false by default)

Default:

false

rights

public abstract GQLEntityRights[] rights

Rights for annotated entity

Returns:

an array of GQLEntityRights

Default:

{}