IsCobol (Veryant isCOBOL Java Documentation)

java.lang.Object
- com.iscobol.java.IsCobol

All Implemented Interfaces:

IscobolCall, IscobolModule
```
public class IsCobol
extends Object
implements IscobolCall
```
isCOBOL interface from Java language. Every static method can throw an IscobolRuntimeException.

Field Summary

Fields
Modifier and Type	Field and Description
`static Object[]`	`NOARGS` Conventional argument indicating "no arguments" for subroutines compiled without using the -cp option.
`static Object[]`	`NOARGS_CP` Conventional argument indicating "no arguments" for subroutines compiled using the -cp option.

Constructor Summary

Constructors
Constructor and Description

IsCobol()

Constructors
Constructor and Description
`IsCobol()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`call(Object[] argv)` empty implementation of com.iscobol.rts.IscobolCall.call(Object[])
`static int`	`call(String name, Object[] argv)` Enables Java programs to call COBOL programs.
`static int`	`call(String name, Object[] argv, boolean stopOnError)` Enables Java programs to call COBOL programs.
`static int`	`call(String name, Object[] argv, boolean stopOnError, Object[] retVal)` Enables Java programs to call COBOL programs.
`static int`	`call(String name, String[] strArgv)` Enables Java programs to call COBOL programs.
`static int`	`call(String name, String[] strArgv, Object[] retVal)` Enables Java programs to call COBOL programs.
`static int`	`callNoStop(String name, Object[] argv)` Enables Java programs to call COBOL programs.
`static int`	`callNoStop(String name, Object[] argv, Object[] retVal)` Enables Java programs to call COBOL programs.
`static void`	`cancel(String name)` Cancels the COBOL program name previously called.
`static void`	`cancelAll()` Cancels all the COBOL programs previously called.
`static void`	`destroyIscobolEnv(Thread th)` Destroys the isCOBOL environment associated to the `th` thread.
`static void`	`duplicateIscobolEnv(Thread src, Thread dst)` Duplicates the isCOBOL environment of the `src` thread in the `dst` thread.
`static boolean`	`exists(String programName)` return `true` if the program specified by `programName` is available in the classpath or code_prefix
`void`	`finalize()` empty implementation of com.iscobol.rts.IscobolCall.finalize()
`static String`	`getEnvironment(String key)` Returns the value of a property.
`static Map<String,String>`	`getEnvironmentList()` Returns the list of the iscobol properties currently set
`static ResultSet[]`	`getResultSets()` returns the the java.sql.ResultSet instances created by the isCOBOL application from the last call of the 'registerResultSets' method, terminates and clears the registration
`static String`	`getStackTrace(Throwable t)` return a string containing the stack trace of the specified java.lang.Throwable object
`static void`	`loadEnvironment(File propFile)` Sets the properties contained in the specified file; it is equivalent to `loadEnvironment(propFile, true)`
`static void`	`loadEnvironment(File propFile, boolean append)` Sets the properties contained in the specified file
`void`	`perform(int begin, int end)` empty implementation of com.iscobol.rts.IscobolModule.perform(int, int)
`static void`	`registerResultSets()` starts the registration of the java.sql.ResultSet instances created by the isCOBOL application
`static void`	`setEnvironment(String key, String value)` Set a property.
`static void`	`tidy()` Shutdown the isCOBOL environment.This method should be invoked before the end of each thread.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NOARGS
```
public static final Object[] NOARGS
```
    Conventional argument indicating "no arguments" for subroutines compiled without using the -cp option.
  - NOARGS_CP
```
public static final Object[] NOARGS_CP
```
    Conventional argument indicating "no arguments" for subroutines compiled using the -cp option.
- Constructor Detail
  - IsCobol
```
public IsCobol()
```
- Method Detail
  - call
```
public Object call(Object[] argv)
```
    empty implementation of com.iscobol.rts.IscobolCall.call(Object[])
    
    Specified by:
    
    call in interface IscobolCall
    
    Returns:
    
    always null
  - perform
```
public void perform(int begin,
                    int end)
```
    empty implementation of com.iscobol.rts.IscobolModule.perform(int, int)
    
    Specified by:
    
    perform in interface IscobolModule
  - finalize
```
public void finalize()
```
    empty implementation of com.iscobol.rts.IscobolCall.finalize()
    
    Specified by:
    
    finalize in interface IscobolCall
    
    Overrides:
    
    finalize in class Object
  - tidy
```
public static void tidy()
                 throws IscobolRuntimeException
```
    Shutdown the isCOBOL environment.This method should be invoked before the end of each thread.
    
    Throws:
    
    IscobolRuntimeException
  - call
```
public static int call(String name,
                       Object[] argv)
                throws IscobolRuntimeException
```
    Enables Java programs to call COBOL programs. Same as call(name, argv, true, null)
    
    Parameters:
    
    name - program to call;
    
    argv - Array of Objects containing the Linkage Section variables: from the first argument this method gets if the called program is compiled with or without -cp; in order to call a subroutine without arguments, two conventional constants are supplied, NOARGS and NOARGS_CP; a null value is interpreted as NOARGS;
    
    Returns:
    
    CALL return code;
    
    Throws:
    
    IscobolRuntimeException
  - call
```
public static int call(String name,
                       Object[] argv,
                       boolean stopOnError)
                throws IscobolRuntimeException
```
    Enables Java programs to call COBOL programs. Same as call(name, argv, stopOnError, null) Parameters are passed BY REFERENCE; This function resembles the COBOL CALL statement.
    
    Parameters:
    
    name - program to call;
    
    argv - Array of Objects containing the Linkage Section variables: from the first argument this method gets if the called program is compiled with or without -cp; in order to call a subroutine without arguments, two conventional constants are supplied, NOARGS and NOARGS_CP; a null value is interpreted as NOARGS;
    
    stopOnError - if true the framework stops the execution in case of errors, otherwise the method throws an exception
    
    Returns:
    
    CALL return code;
    
    Throws:
    
    IscobolRuntimeException
  - call
```
public static int call(String name,
                       Object[] argv,
                       boolean stopOnError,
                       Object[] retVal)
                throws IscobolRuntimeException
```
    Enables Java programs to call COBOL programs. Parameters are passed BY REFERENCE; This function resembles the COBOL CALL statement.
    
    Parameters:
    
    name - program to call;
    
    argv - Array of Objects containing the Linkage Section variables: from the first argument this method gets if the called program is compiled with or without -cp; in order to call a subroutine without arguments, two conventional constants are supplied, NOARGS and NOARGS_CP; a null value is interpreted as NOARGS;
    
    stopOnError - if true the framework stops the execution in case of errors, otherwise the method throws an exception
    
    retVal - When is not null and not zero length, its first element is set with the Object returned by the CALL
    
    Returns:
    
    CALL return code;
    
    Throws:
    
    IscobolRuntimeException
  - call
```
public static int call(String name,
                       String[] strArgv)
                throws IscobolRuntimeException
```
    Enables Java programs to call COBOL programs. Same as call(name, strArgv, null) The arguments are passed as a String array and they'll be available in the called program as if they were passed on the command line.
    
    Parameters:
    
    name - program to call;
    
    strArgv - Array of String containing the argument as if were on the command line
    
    Returns:
    
    CALL return code;
    
    Throws:
    
    IscobolRuntimeException
  - call
```
public static int call(String name,
                       String[] strArgv,
                       Object[] retVal)
                throws IscobolRuntimeException
```
    Enables Java programs to call COBOL programs. The arguments are passed as a String array and they'll be available in the called program as if they were passed on the command line.
    
    Parameters:
    
    name - program to call;
    
    strArgv - Array of String containing the argument as if were on the command line
    
    retVal - When is not null and not zero length, its first element is set with the Object returned by the CALL
    
    Returns:
    
    CALL return code;
    
    Throws:
    
    IscobolRuntimeException
  - callNoStop
```
public static int callNoStop(String name,
                             Object[] argv)
                      throws StopRunAsException,
                             IscobolRuntimeException,
                             AssertionError
```
    Enables Java programs to call COBOL programs. Same as callNoStop(name, argv, null), when a STOP RUN statement is encountered, the run unit doesn't terminate and an exception of class com.iscobol.java.StopRunAsException is thrown. Using this method doesn't guarantee that all threads are terminated, in particular the threads that handle the GUI, so it should be used for testing purposes only.
    
    Parameters:
    
    name - program to call;
    
    argv - Array of Objects containing the Linkage Section variables: from the first argument this method gets if the called program is compiled with or without -cp; in order to call a subroutine without arguments, two conventional constants are supplied, NOARGS and NOARGS_CP; a null value is interpreted as NOARGS;
    
    Returns:
    
    CALL return code;
    
    Throws:
    
    StopRunAsException
    
    IscobolRuntimeException
    
    AssertionError
  - callNoStop
```
public static int callNoStop(String name,
                             Object[] argv,
                             Object[] retVal)
                      throws StopRunAsException,
                             IscobolRuntimeException,
                             AssertionError
```
    Enables Java programs to call COBOL programs. Same as call(name, argv, false, null), however when a STOP RUN statement is encountered, the run unit doesn't terminate and an exception of class com.iscobol.java.StopRunAsException is thrown. Using this method doesn't guarantee that all threads are terminated, in particular the threads that handle the GUI, so it should be used for testing purposes only.
    
    Parameters:
    
    name - program to call;
    
    argv - Array of Objects containing the Linkage Section variables: from the first argument this method gets if the called program is compiled with or without -cp; in order to call a subroutine without arguments, two conventional constants are supplied, NOARGS and NOARGS_CP; a null value is interpreted as NOARGS;
    
    retVal - When is not null and not zero length, its first element is set with the Object returned by the CALL
    
    Returns:
    
    CALL return code;
    
    Throws:
    
    StopRunAsException
    
    IscobolRuntimeException
    
    AssertionError
  - cancel
```
public static void cancel(String name)
                   throws IscobolRuntimeException
```
    Cancels the COBOL program name previously called.
    
    Parameters:
    
    name - program to cancel;
    
    Throws:
    
    IscobolRuntimeException
  - cancelAll
```
public static void cancelAll()
                      throws IscobolRuntimeException
```
    Cancels all the COBOL programs previously called.
    
    Throws:
    
    IscobolRuntimeException
  - setEnvironment
```
public static void setEnvironment(String key,
                                  String value)
```
    Set a property.
    
    Parameters:
    
    key - property name without the iscobol. prefix;
    
    value - the value of the property.
  - getEnvironment
```
public static String getEnvironment(String key)
```
    Returns the value of a property.
    
    Parameters:
    
    key - property name without the iscobol. prefix;
    
    Returns:
    
    the value of the property.
  - getEnvironmentList
```
public static Map<String,String> getEnvironmentList()
```
    Returns the list of the iscobol properties currently set
  - loadEnvironment
```
public static void loadEnvironment(File propFile)
                            throws IOException
```
    Sets the properties contained in the specified file; it is equivalent to loadEnvironment(propFile, true)
    
    Parameters:
    
    propFile - the file that contains the properties to be set
    
    Throws:
    
    IOException
  - loadEnvironment
```
public static void loadEnvironment(File propFile,
                                   boolean append)
                            throws IOException
```
    Sets the properties contained in the specified file
    
    Parameters:
    
    propFile - the file that contains the properties to be set
    
    append - when set to false removes all the properties previously set, before adding the new ones
    
    Throws:
    
    IOException
  - getStackTrace
```
public static String getStackTrace(Throwable t)
```
    return a string containing the stack trace of the specified java.lang.Throwable object
    
    Parameters:
    
    t - the java.lang.Throwable object
  - registerResultSets
```
public static void registerResultSets()
```
    starts the registration of the java.sql.ResultSet instances created by the isCOBOL application
  - getResultSets
```
public static ResultSet[] getResultSets()
```
    returns the the java.sql.ResultSet instances created by the isCOBOL application from the last call of the 'registerResultSets' method, terminates and clears the registration
  - exists
```
public static boolean exists(String programName)
```
    return true if the program specified by programName is available in the classpath or code_prefix
    
    Parameters:
    
    programName - the name of the program
  - duplicateIscobolEnv
```
public static void duplicateIscobolEnv(Thread src,
                                       Thread dst)
```
    Duplicates the isCOBOL environment of the src thread in the dst thread.
    This method makes the dst thread equivalent to a thread generated by a 'CALL THREAD' statement executed by the src thread, so it can share the configuration, the EXTERNAL variables and the connection with the Client in Application Server environment.
    When the execution of dst thread terminates, the destroyIscobolEnv(dst) method should be invoked.
    
    Parameters:
    
    src - the source thread
    
    dst - the destination thread
  - destroyIscobolEnv
```
public static void destroyIscobolEnv(Thread th)
```
    Destroys the isCOBOL environment associated to the th thread.
    This method should be invoked when the execution of a thread previously associated to the isCOBOL environment via the duplicateIscobolEnv method terminates
    
    Parameters:
    
    th - the thread to be associated with the isCOBOL environment

Class IsCobol

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOARGS

NOARGS_CP

Constructor Detail

IsCobol

Method Detail

call

perform

finalize

tidy

call

call

call

call

call

callNoStop

callNoStop

cancel

cancelAll

setEnvironment

getEnvironment

getEnvironmentList

loadEnvironment

loadEnvironment

getStackTrace

registerResultSets

getResultSets

exists

duplicateIscobolEnv

destroyIscobolEnv