Package io.vertigo.vega.webservice.model

Interface UiObject<D extends DtObject>

Type Parameters:
D - DtObject type
All Superinterfaces:
Serializable
All Known Implementing Classes:
VegaUiObject
public interface UiObject<D extends DtObject> extends Serializable
UiObject is used as an Input buffer from client. It managed to : - merge a serverSideObject and an inputBufferObject - check validators - return merged Object
Author:
pchretien, npiedeloup

  • Method Details

    • getDtDefinition

      DtDefinition getDtDefinition()
      Returns:
      DtDefinition de l'objet métier

    • setInputKey

      void setInputKey(String inputKey)
      Parameters:
      inputKey - Object reference keep in this request context (for error handling)

    • getInputKey

      String getInputKey()
      Returns:
      Object reference keep in this request context (for error handling)

    • getServerSideObject

      D getServerSideObject()
      Returns:
      the version stored in the server.

    • setServerSideObject

      void setServerSideObject(D dtObject)
      Affect the server's version.
      Parameters:
      dtObject - the objet held by the server

    • getServerSideToken

      String getServerSideToken()

    • setServerSideToken

      void setServerSideToken(String asString)

    • checkFormat

      boolean checkFormat(UiMessageStack uiMessageStack)
      Vérifie les UiObjects de la liste et remplis la pile d'erreur.
      Parameters:
      validator - Validateur à utilisé
      uiMessageStack - Pile des messages qui sera mise à jour
      Returns:
      if the object is valid (no format errors) if it's not valid you must not call mergeAndCheckInput

    • mergeAndCheckInput

      D mergeAndCheckInput(List<DtObjectValidator<D>> dtObjectValidators, UiMessageStack uiMessageStack)
      Merge et Valide l'objet d'IHM et place les erreurs rencontrées dans la stack.
      Parameters:
      dtObjectValidators - Validateurs à utiliser, peut-être spécifique à l'objet.
      uiMessageStack - Pile des messages qui sera mise à jour
      Returns:
      Objet métier mis à jour

    • isModified

      boolean isModified(String fieldName)
      Parameters:
      fieldName - Champs
      Returns:
      Si le champs à été modifié dans le UiObject

    • isModified

      boolean isModified()
      Returns:
      if object is modified (anyfield)

    • getModifiedFields

      Set<String> getModifiedFields()
      Returns:
      All modified fieldNames (camel)

    • getInputValue

      String[] getInputValue(String fieldName)
      Get the value in the buffer.
      Parameters:
      fieldName - name of the field (camelCase)
      Returns:
      the value in the buffer (can be null, if no data and not multiple)

    • getSingleInputValue

      String getSingleInputValue(String fieldName)
      Get the value in the buffer for a know monovalued field.
      Parameters:
      fieldName - name of the field (camelCase)
      Returns:
      the value in the buffer (can be null, if no data and not multiple)

    • setInputValue

      void setInputValue(String fieldName, String... stringValue)
      Set the value in the buffer.
      Parameters:
      fieldName - name of the field (camelCase)
      stringValue - the value as String

    • setTypedValue

      void setTypedValue(String fieldName, Serializable value)
      Set a typed value in the buffer.
      Parameters:
      fieldName - name of the field (camelCase)
      value - the typed value

    • getTypedValue

      <T> T getTypedValue(String fieldName, Class<T> type)
      Parameters:
      dtField - Champs
      Returns:
      Valeur typée du champs
      Throws:
      IllegalAccessError - Si le champs possède une erreur de formatage

    • getInteger

      Integer getInteger(String fieldName)
      Parameters:
      fieldName - Nom du champs
      Returns:
      Valeur typée

    • getLong

      Long getLong(String fieldName)
      Parameters:
      fieldName - Nom du champs
      Returns:
      Valeur typée

    • getString

      String getString(String fieldName)
      Parameters:
      fieldName - Nom du champs
      Returns:
      Valeur typée

    • getBoolean

      Boolean getBoolean(String fieldName)
      Parameters:
      fieldName - Nom du champs
      Returns:
      Valeur typée

    • getLocalDate

      LocalDate getLocalDate(String fieldName)
      Parameters:
      fieldName - Nom du champs
      Returns:
      Valeur typée

    • getInstant

      Instant getInstant(String fieldName)
      Parameters:
      fieldName - Nom du champs
      Returns:
      Valeur typée

    • getDouble

      Double getDouble(String fieldName)
      Parameters:
      fieldName - Nom du champs
      Returns:
      Valeur typée

    • getBigDecimal

      BigDecimal getBigDecimal(String fieldName)
      Parameters:
      fieldName - Nom du champs
      Returns:
      Valeur typée