Package dev.galasa.cicsts

Interface ICeciResponseOutputValue

public interface ICeciResponseOutputValue
Represents the value of an output field returned as the response from a CECI request. Where a field is not numeric, the value is stored as both a string and a char array representing text and the hex values retrieved from the screen. In this case, the 2 representations of the value are stored in an array and isArray() returns true.
e.g. the request output screen might show:
INTO('A.....')
and in Hex:
INTO(X'C13456789ABC')
example hex in javadoc comment //pragma: allowlist secret Both representations are available using the getTextValue() and getHexValue() methods respectively

  • Method Summary

    Modifier and Type
    Method
    Description
    char[]
    getHexValue()
    Returns the hex value of the output field
    int
    getIntValue()
    Returns an the int value of the output field
    long
    getLongValue()
    Returns a long value of the output field
    String
    getTextValue()
    Returns the text value of the output field
    boolean
    isArray()
    Is the value is held in both text and hex formats

  • Method Details

    • getTextValue

      String getTextValue()
      Returns the text value of the output field
      Returns:
      value as a string

    • getHexValue

      char[] getHexValue()
      Returns the hex value of the output field
      Returns:
      value as a char array

    • getIntValue

      int getIntValue() throws CeciException
      Returns an the int value of the output field
      Returns:
      value as an int
      Throws:
      CeciException

    • getLongValue

      long getLongValue() throws CeciException
      Returns a long value of the output field
      Returns:
      value as a long
      Throws:
      CeciException

    • isArray

      boolean isArray()
      Is the value is held in both text and hex formats
      Returns:
      true if value is an array