com.daikit.graphql.meta

Annotation Type GQLAttribute

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface GQLAttribute

Annotation for entity attribute 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 (if true it is equivalent to read==false AND save==false).
boolean	filter Get whether this attribute can used as a filter property by client.
boolean	mandatory Get whether this attribute is mandatory when parent entity is created/updated.
boolean	mandatoryForCreate Get whether this attribute is mandatory when parent entity is created.
boolean	mandatoryForUpdate Get whether this attribute is mandatory when parent entity is updated.
String	name Provide a value here in order to change the name under which the annotated attribute will be accessible in the API.
boolean	nullable Get whether this attribute can be nullified when parent entity is created/updated.
boolean	nullableForCreate Get whether this attribute can be nullified when parent entity is created.
boolean	nullableForUpdate Get whether this attribute can be nullified when parent entity is updated.
boolean	read Get whether this attribute is readable by client.
boolean	readOnly Get whether this attribute is read only (if true it is equivalent to read==true AND save==false).
boolean	save Get whether this attribute can be written by client when creating/updating parent entity instance.

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 (if true it is equivalent to read==false AND save==false).

Returns:

a boolean (false by default)

Default:

false

readOnly

public abstract boolean readOnly

Get whether this attribute is read only (if true it is equivalent to read==true AND save==false).

Returns:

a boolean (false by default)

Default:

false

read

public abstract boolean read

Get whether this attribute is readable by client.

Returns:

a boolean (true by default)

Default:

true

save

public abstract boolean save

Get whether this attribute can be written by client when creating/updating parent entity instance.

Returns:

a boolean (true by default)

Default:

true

filter

public abstract boolean filter

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

Returns:

a boolean (true by default)

Default:

true

nullable

public abstract boolean nullable

Get whether this attribute can be nullified when parent entity is created/updated. If you need more granularity consider using nullableForCreate() or nullableForUpdate() instead.

Returns:

a boolean (true by default)

Default:

true

nullableForCreate

public abstract boolean nullableForCreate

Get whether this attribute can be nullified when parent entity is created. Setting this property has precedence over setting nullable() property.

Returns:

a boolean (true by default)

Default:

true

nullableForUpdate

public abstract boolean nullableForUpdate

Get whether this attribute can be nullified when parent entity is updated. Setting this property has precedence over setting nullable() property.

Returns:

a boolean (true by default)

Default:

true

mandatory

public abstract boolean mandatory

Get whether this attribute is mandatory when parent entity is created/updated. If you need more granularity consider using mandatoryForCreate() or mandatoryForUpdate() instead.

Returns:

a boolean (false by default)

Default:

true

mandatoryForCreate

public abstract boolean mandatoryForCreate

Get whether this attribute is mandatory when parent entity is created. Setting this property has precedence over setting mandatory() property.

Returns:

a boolean (false by default)

Default:

true

mandatoryForUpdate

public abstract boolean mandatoryForUpdate

Get whether this attribute is mandatory when parent entity is updated. Setting this property has precedence over setting mandatory() property.

Returns:

a boolean (false by default)

Default:

true