PsaRstApiMapCom

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

REST API: Annotation for mapping JSON fields to data of a component (read only)

Since:: 21.07.2023
Author:: weiland

Required Element Summary

Required Elements

Modifier and Type

Required Element

Description

String

componentDataField

component data field

String

componentDto

component data object

String

sourceKeyField

source key field
Optional Element Summary

Optional Elements

Modifier and Type

Optional Element

Description

boolean

cache

use cached values (default = false)

String

componentKeyField

component key field (default = PSC_GID)

Element Details
- componentDto
  
  String componentDto
  
  component data object
  
  Returns:
  
  data object
- sourceKeyField
  
  String sourceKeyField
  
  source key field
  
  Returns:
  
  field
- componentDataField
  
  String componentDataField
  
  component data field
  
  Returns:
  
  field
- componentKeyField
  
  String componentKeyField
  
  component key field (default = PSC_GID)
  
  Returns:
  
  field
  
  Default:
  
  "PSC_GID"
- cache
  
  boolean cache
  
  use cached values (default = false)
  
  Returns:
  
  if true the values will be stored in the global cache. otherwise the data will read from the database
  
  Default:
  
  false