com.daikit.graphql.meta

Annotation Type GQLAttributeRights

public @interface GQLAttributeRights

Annotation for entity attribute rights for customizing CRUD

Author:

Thibaut Caselli

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	exclude Get whether this attribute is excluded from transport to 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.
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).
String[]	roles The role these rights are for.
boolean	save Get whether this attribute can be written by client when creating/updating parent entity instance.

Element Detail

roles

public abstract String[] roles

The role these rights are for. Default is empty for a config applied to all roles.

Returns:

a string role

Default:

{}

exclude

public abstract boolean exclude

Get whether this attribute is excluded from transport to client. If this is true then rights are ignored for this attribute and these roles.

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

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:

false

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:

false

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:

false