com.heirloomcomputing.ecs.api

Interface IProgramEnvironment

All Superinterfaces:

IEnvironment

public interface IProgramEnvironment
extends IEnvironment

The interface to the program environment

Field Summary

Fields

Modifier and Type	Field and Description
static int	CCE Condition Code Equal constant
static int	CCG Condition Code Greater constant
static int	CCL Condition Code Lesser constant

Method Summary

Modifier and Type	Method and Description
int	getCC() Get the Condition Code register value.
java.lang.Object	getExternal(java.lang.String name) Get the EXTERNAL identifier by name.
com.heirloomcomputing.ecs.ezasoket.EzasoketContext	getEzasoketContext() Get the EzasoketContect object
java.lang.Object	getJDBCConnection(java.lang.String name) Get the named SQL JDBC Connection.
java.lang.Object	getJMSConnection(java.lang.String name) Get the named JMS Connection.
IModule	getModule(java.lang.String moduleName) Obtain the given module, where the module must be known to the current IProgramEnvironment.
boolean	isExecutingInTransactionEnvironment() Is this program running in a hosted transaction environment? This is true for environments such as the LegacyJ Transaction Platform, and false for simple environments such as a normal application.
void	setCC(int value) Set the Condition Code register value.
void	setJDBCConnection(java.lang.String name, java.lang.Object con) Set the named SQL JDBC Connection.
void	setJMSConnection(java.lang.String name, java.lang.Object con) Set the named JMS Connection.

Methods inherited from interface com.heirloomcomputing.ecs.api.IEnvironment

get, put, remove

Field Detail

CCE

static final int CCE

Condition Code Equal constant

See Also:

Constant Field Values

CCG

static final int CCG

Condition Code Greater constant

See Also:

Constant Field Values

CCL

static final int CCL

Condition Code Lesser constant

See Also:

Constant Field Values

Method Detail

getCC

int getCC()

Get the Condition Code register value. The Condition Code is an HP3000/MPE concept, used primarily for passing back status information from intrinsic calls. It is accessible in Cobol code as CONDITION-CODE.

Returns:

condition code value (CCE, CCG, CCL)

setCC

void setCC(int value)

Set the Condition Code register value. The Condition Code is an HP3000/MPE concept, used primarily for passing back status information from intrinsic calls. It is accessible in Cobol code as CONDITION-CODE. If implementing a custom intrinsic, set the Condition Code using this method to one of the CC constants.

Parameters:

value - - condition code value (CCE, CCG, CCL)

isExecutingInTransactionEnvironment

boolean isExecutingInTransactionEnvironment()

Is this program running in a hosted transaction environment? This is true for environments such as the LegacyJ Transaction Platform, and false for simple environments such as a normal application.

Returns:

true if running in a hosted transaction environment.

getJDBCConnection

java.lang.Object getJDBCConnection(java.lang.String name)

Get the named SQL JDBC Connection.

Parameters:

name - - null for current

Returns:

JDBC connection object, typically of class java.sql.Connection

setJDBCConnection

void setJDBCConnection(java.lang.String name,
                       java.lang.Object con)
                throws java.lang.Exception

Set the named SQL JDBC Connection.

Parameters:

name - of the connection object being set, null for current

con - is the connection object itself

at-throws an Exception when an unrecoverable error occurs

(note: javadoc 1.8_0.181 fails to find at-throws; fixed in javadoc 1.8_0.191)

Throws:

java.lang.Exception

getJMSConnection

java.lang.Object getJMSConnection(java.lang.String name)

Get the named JMS Connection.

Parameters:

name - - null for current

Returns:

JMS connection object

setJMSConnection

void setJMSConnection(java.lang.String name,
                      java.lang.Object con)
               throws java.lang.Exception

Set the named JMS Connection.

Parameters:

name - of the connection object being set, null for current

con - is the connection object itself

at-throws an Exception when an unrecoverable error occurs

(note: javadoc 1.8_0.181 fails to find at-throws; fixed in javadoc 1.8_0.191)

Throws:

java.lang.Exception

getExternal

java.lang.Object getExternal(java.lang.String name)

Get the EXTERNAL identifier by name. The identifier must have been declared previously to be available. A null will be returned if unavailable. The type of the returned object varies according to the declared identifier. It will generally implement IDatatype.

Parameters:

name - the String name representing the external identifier to get

Returns:

external identifier

getModule

IModule getModule(java.lang.String moduleName)

Obtain the given module, where the module must be known to the current IProgramEnvironment.

Parameters:

moduleName - the name of the module to get

Returns:

the IModule, which may be null if unknown

getEzasoketContext

com.heirloomcomputing.ecs.ezasoket.EzasoketContext getEzasoketContext()

Get the EzasoketContect object

Returns:

EzasoketContext object