HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.common.customlogic
Class GlobalVariableScreenReco

java.lang.Object
  extended by com.ibm.hats.common.customlogic.AbstractAdvancedCustomScreenRecoListener
      extended by com.ibm.hats.common.customlogic.GlobalVariableScreenReco
All Implemented Interfaces:
ECLCustomRecoListener, com.ibm.hats.common.customlogic.IAdvancedApplicationInfoListener, com.ibm.hats.common.customlogic.IAdvancedCustomScreenRecoListener

public class GlobalVariableScreenReco
extends AbstractAdvancedCustomScreenRecoListener

Class Name: GlobalVariableScreenReco
Class Type:
Normal
Base Class:
AbstractAdvancedCustomScreenRecoListener
Intf Class:
None
Description:
This is the HATS implementation of a custom screen reco for Global Variable evaluation.

See Also:
AbstractAdvancedCustomScreenRecoListener

Field Summary
static String _CLOSE_PROP
          String separator constant for parsing from string.
static String _CLOSE_VAR
          String separator constant for parsing from string.
static String _OPEN_PROP
          String separator constant for parsing from string.
static String _OPEN_VAR
          String separator constant for parsing from string.
static String _PROP_SEP
          String separator constant for parsing from string.
static String _PROP_SET
          String separator constant for parsing from string.
static String _VALUE
          String constant for parsing data from string.
static String BOOLEAN
          String constant for parsing from string.
static String CLASSNAME
          The fully-qualified name of this class.
static String EQUAL
          String constant for parsing evaluation operators from string.
static String EXISTS
          String constant for parsing evaluation operators from string.
static String GREATERTHAN
          String constant for parsing evaluation operators from string.
static String GREATERTHANOREQUAL
          String constant for parsing evaluation operators from string.
static String GV_RES_SHARED
          String constant for parsing Global Variable content from string.
static String GVINDEX
          String constant for parsing Global Variable content from string.
static String GVINDEXED
          String constant for parsing Global Variable content from string.
static String GVNAME
          String constant for parsing Global Variable content from string.
static String GVOPTION
          String constant for parsing Global Variable content from string.
static String GVRESOURCE
          String constant for parsing Global Variable content from string.
static String INTEGER
          String constant for parsing from string.
static String LENGTH
          String constant for parsing from string.
static String LESSTHAN
          String constant for parsing evaluation operators from string.
static String LESSTHANOREQUAL
          String constant for parsing evaluation operators from string.
static String NOTEQUAL
          String constant for parsing evaluation operators from string.
static String OBJECT
          String constant for parsing from string, only valid for global variable options.
static String STRING
          String constant for parsing from string.
static String VALUE
          String constant for parsing data from string.
static String VARIABLE
          String constant for parsing from string.
 
Constructor Summary
GlobalVariableScreenReco()
           
 
Method Summary
 Object createType(String typeDecl, BusinessLogicInfo bli)
          Deprecated.  
 Object createType(String typeDecl, IBusinessLogicInformation bli)
          Parses the operand string and creates an object based on an evaluation of that string, separating type from value from the initial parameter in the custom screen reco.
 Object createType(String type, String values, BusinessLogicInfo bli)
          Deprecated.  
 Object createType(String type, String values, IBusinessLogicInformation bli)
          Parses the operand string and creates an object based on an evaluation of that string.
 boolean equate(Object operand1, String op, Object operand2)
          Equates two objects using an operator.
 boolean isRecognized(String settings, BusinessLogicInfo bli, ECLPS ps, ECLScreenDesc screenDescription)
          Deprecated.  
 boolean isRecognized(String settings, IBusinessLogicInformation bli, ECLPS ps, ECLScreenDesc screenDescription)
          Evaluates the claim of screen recognition for the descriptor given.
 String[] polishNotationSplitEquation(String setting)
          Evaluates the data in the custom screen reco label and parses for use.
 
Methods inherited from class com.ibm.hats.common.customlogic.AbstractAdvancedCustomScreenRecoListener
DoReco, setApplicationInfo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASSNAME

public static final String CLASSNAME
The fully-qualified name of this class. This is used for controlling and displaying traces.


VARIABLE

public static final String VARIABLE
String constant for parsing from string.

See Also:
Constant Field Values

INTEGER

public static final String INTEGER
String constant for parsing from string.

See Also:
Constant Field Values

BOOLEAN

public static final String BOOLEAN
String constant for parsing from string.

See Also:
Constant Field Values

STRING

public static final String STRING
String constant for parsing from string.

See Also:
Constant Field Values

OBJECT

public static final String OBJECT
String constant for parsing from string, only valid for global variable options.

See Also:
Constant Field Values

VALUE

public static final String VALUE
String constant for parsing data from string.

See Also:
Constant Field Values

LENGTH

public static final String LENGTH
String constant for parsing from string.

See Also:
Constant Field Values

EXISTS

public static final String EXISTS
String constant for parsing evaluation operators from string.

See Also:
Constant Field Values

EQUAL

public static final String EQUAL
String constant for parsing evaluation operators from string.

See Also:
Constant Field Values

NOTEQUAL

public static final String NOTEQUAL
String constant for parsing evaluation operators from string.

See Also:
Constant Field Values

GREATERTHAN

public static final String GREATERTHAN
String constant for parsing evaluation operators from string.

See Also:
Constant Field Values

LESSTHAN

public static final String LESSTHAN
String constant for parsing evaluation operators from string.

See Also:
Constant Field Values

GREATERTHANOREQUAL

public static final String GREATERTHANOREQUAL
String constant for parsing evaluation operators from string.

See Also:
Constant Field Values

LESSTHANOREQUAL

public static final String LESSTHANOREQUAL
String constant for parsing evaluation operators from string.

See Also:
Constant Field Values

GVNAME

public static final String GVNAME
String constant for parsing Global Variable content from string.

See Also:
Constant Field Values

GVOPTION

public static final String GVOPTION
String constant for parsing Global Variable content from string.

See Also:
Constant Field Values

GVINDEXED

public static final String GVINDEXED
String constant for parsing Global Variable content from string.

See Also:
Constant Field Values

GVINDEX

public static final String GVINDEX
String constant for parsing Global Variable content from string.

See Also:
Constant Field Values

GVRESOURCE

public static final String GVRESOURCE
String constant for parsing Global Variable content from string.

See Also:
Constant Field Values

GV_RES_SHARED

public static final String GV_RES_SHARED
String constant for parsing Global Variable content from string.

See Also:
Constant Field Values

_VALUE

public static final String _VALUE
String constant for parsing data from string.

See Also:
Constant Field Values

_PROP_SEP

public static final String _PROP_SEP
String separator constant for parsing from string.

See Also:
Constant Field Values

_PROP_SET

public static final String _PROP_SET
String separator constant for parsing from string.

See Also:
Constant Field Values

_OPEN_PROP

public static final String _OPEN_PROP
String separator constant for parsing from string.

See Also:
Constant Field Values

_CLOSE_PROP

public static final String _CLOSE_PROP
String separator constant for parsing from string.

See Also:
Constant Field Values

_OPEN_VAR

public static final String _OPEN_VAR
String separator constant for parsing from string.

See Also:
Constant Field Values

_CLOSE_VAR

public static final String _CLOSE_VAR
String separator constant for parsing from string.

See Also:
Constant Field Values
Constructor Detail

GlobalVariableScreenReco

public GlobalVariableScreenReco()
Method Detail

isRecognized

public boolean isRecognized(String settings,
                            IBusinessLogicInformation bli,
                            ECLPS ps,
                            ECLScreenDesc screenDescription)
Description copied from class: AbstractAdvancedCustomScreenRecoListener
Evaluates the claim of screen recognition for the descriptor given.

Specified by:
isRecognized in class AbstractAdvancedCustomScreenRecoListener
Parameters:
settings - The settings.
bli - The business logic information interface.
ps - The ECLPS object.
screenDescription - The screen description.
Returns:
True if recognized, false otherwise.
See Also:
AbstractAdvancedCustomScreenRecoListener.isRecognized( String, IBusinessLogicInformation, ECLPS, ECLScreenDesc)

equate

public boolean equate(Object operand1,
                      String op,
                      Object operand2)
Equates two objects using an operator.

Parameters:
operand1 - The first object.
op - The operator.
operand2 - The second object.
Returns:
Return true if the objects are equal, false otherwise.

createType

public Object createType(String type,
                         String values,
                         IBusinessLogicInformation bli)
Parses the operand string and creates an object based on an evaluation of that string.

Parameters:
type - The object type to be created.
values - The data for that object to be instantiated with.
bli - The business logic information and references.
Returns:
The object that is the result of the creation

createType

public Object createType(String typeDecl,
                         IBusinessLogicInformation bli)
Parses the operand string and creates an object based on an evaluation of that string, separating type from value from the initial parameter in the custom screen reco.

Parameters:
typeDecl - The object type to be created.
bli - The business logic information and references.
Returns:
The object that is the result of the creation.

polishNotationSplitEquation

public String[] polishNotationSplitEquation(String setting)
Evaluates the data in the custom screen reco label and parses for use.

Parameters:
setting - The setting data from the screen reco information.
Returns:
The strings resulting from the parsing step.

isRecognized

public boolean isRecognized(String settings,
                            BusinessLogicInfo bli,
                            ECLPS ps,
                            ECLScreenDesc screenDescription)
Deprecated. 

True if recognized, false otherwise.

Parameters:
settings - The settings.
bli - The business logic information interface.
ps - The ECLPS object.
screenDescription - The screen description.
Returns:
True if recognized, false otherwise.
See Also:
GlobalVariableScreenReco.isRecognized(String, IBusinessLogicInformation, ECLPS, ECLScreenDesc)

createType

public Object createType(String type,
                         String values,
                         BusinessLogicInfo bli)
Deprecated. 

Parses the operand string and creates an object based on an evaluation of that string.

Parameters:
type - The object type to be created.
values - The data to be used for object instantiation.
bli - The business logic information and references.
Returns:
The object that is the result of the creation.
See Also:
GlobalVariableScreenReco.createType(String, String, IBusinessLogicInformation)

createType

public Object createType(String typeDecl,
                         BusinessLogicInfo bli)
Deprecated. 

Parses the operand string and creates an object based on an evaluation of that string, separating type from value from the initial parameter in the custom screen reco.

Parameters:
typeDecl - The object type to be created.
bli - The business logic information and references.
Returns:
The object that is the result of the creation.
See Also:
GlobalVariableScreenReco.createType(String, IBusinessLogicInformation)

HATS 7.5.1 (201005110649)