Package de.pisa.psa.rst.obj

Annotation Interface PsaRstApiMapFld

@Documented
@Retention(RUNTIME)
@Target(FIELD)
public @interface PsaRstApiMapFld

REST API: Annotation for mapping JSON fields to data object fields

Since:

23.05.2023

Author:

weiland

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PsaRstApiMapFld.MapEntry	mapping entry

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	value	data object field name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
int	keyField	define the key field instead of a field name
boolean	readonly	is this field readonly?

Element Details

value

String value

data object field name

Returns:

field name

keyField

int keyField

define the key field instead of a field name

Returns:

position of the key field

See Also:

• PscDto.getKey(int)

Default:

0

readonly

boolean readonly

is this field readonly?

Returns:

true if the field will only be read (default=false)

Default:

false