Package org.praxisplatform.uischema.dto

Record Class OptionDTO<ID>

java.lang.Object
java.lang.Record
org.praxisplatform.uischema.dto.OptionDTO<ID>
Type Parameters:
ID - tipo do identificador
Record Components:
id - valor identificador
label - rotulo legivel ao usuario
extra - atributos adicionais opcionais
public record OptionDTO<ID>(ID id, String label, Map<String,Object> extra) extends Record
Projecao leve canonica para opcoes de selecao.

OptionDTO e o payload padrao retornado pelos endpoints /options/filter, /options/by-ids e pelas option-sources derivadas. Ele existe para reduzir trafego, evitar exposicao desnecessaria do DTO completo e padronizar o contrato consumido por selects, multiselects e combos dependentes.

Uso em DTOs (@UISchema): referencie /options/filter no endpoint e mapeie valueField/displayField para id/label.

  • Constructor Details

    • OptionDTO

      public OptionDTO(ID id, String label, Map<String,Object> extra)
      Creates an instance of a OptionDTO record class.
      Parameters:
      id - the value for the id record component
      label - the value for the label record component
      extra - the value for the extra record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      public ID id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component

    • extra

      public Map<String,Object> extra()
      Returns the value of the extra record component.
      Returns:
      the value of the extra record component