com.ibm.cics.server
Class IsCICS

java.lang.Object
  extended bycom.ibm.cics.server.IsCICS

public class IsCICS
extends java.lang.Object

Class to call the JNI function ..._DTCisCICS () to, currently, obtain whether we're currently in CICS and/or we can use the CICS API.


Field Summary
static int CICS_REGION_AND_API_ALLOWED
           
static int CICS_REGION_BUT_API_DISALLOWED
           
static int NOT_CICS_REGION
           
static int UNABLE_TO_DETERMINE_STATUS
           
 
Constructor Summary
IsCICS()
           
 
Method Summary
static int getApiStatus()
          getApiStatus () returns the status of the current execution environment
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNABLE_TO_DETERMINE_STATUS

public static final int UNABLE_TO_DETERMINE_STATUS
See Also:
Constant Field Values

NOT_CICS_REGION

public static final int NOT_CICS_REGION
See Also:
Constant Field Values

CICS_REGION_BUT_API_DISALLOWED

public static final int CICS_REGION_BUT_API_DISALLOWED
See Also:
Constant Field Values

CICS_REGION_AND_API_ALLOWED

public static final int CICS_REGION_AND_API_ALLOWED
See Also:
Constant Field Values
Constructor Detail

IsCICS

public IsCICS()
Method Detail

getApiStatus

public static int getApiStatus()
getApiStatus () returns the status of the current execution environment

Returns:
An int corresponding to one of the following constants:

  • CICS_REGION_AND_API_ALLOWED - Executing in CICS and CICS API calls are permitted
  • CICS_REGION_BUT_API_DISALLOWED - Executing in CICS but CICS API calls are not permitted
  • NOT_CICS_REGION - Executing in non-CICS environment
  • UNABLE_TO_DETERMINE_STATUS - Cannot determine current execution environment