dev.galasa.cicsts.ICeciResponseOutputValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.cicsts.manager Show documentation

A Galasa project

There is a newer version: 0.38.0

Show newest version

/*
 * Copyright contributors to the Galasa project
 */

package dev.galasa.cicsts;

/**
 * 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 {@link #isArray()} returns true.
 
 * e.g. the request output screen might 
 * show:

 * INTO('A.....')

 * and in Hex:

 * INTO(X'C13456789ABC')

 * Both representations are available using the {@link #getTextValue()} and {@link #getHexValue()} methods respectively
 */
public interface ICeciResponseOutputValue {

    /**
     * Returns the text value of the output field
     * @return value as a string
     */
    public String getTextValue();

    /**
     * Returns the hex value of the output field
     * @return value as a char array
     */
    public char[] getHexValue();

    /**
     * Returns an the int value of the output field
     * @return value as an int
     */
    public int getIntValue() throws CeciException;

    /**
     * Returns a long value of the output field
     * @return value as a long
     */
    public long getLongValue() throws CeciException;

    /**
     * Is the value is held in both text and hex formats 
     * @return true if value is an array
     */
    public boolean isArray();

}