com.ibm.cics.model
Interface IProgramDefinition

All Superinterfaces:
ICICSDefinition, ICICSObject, IDefinition, com.ibm.cics.model.meta.ITypedObject

public interface IProgramDefinition
extends ICICSDefinition

generated from CICS resourcetable PROGDEF


Nested Class Summary
static class IProgramDefinition.ApiValue
          Enumeration type for field API
static class IProgramDefinition.ConcurrencyValue
          Enumeration type for field CONCURRENCY
static class IProgramDefinition.DatalocationValue
          Enumeration type for field DATALOCATION
static class IProgramDefinition.ExeckeyValue
          Enumeration type for field EXECKEY
static class IProgramDefinition.ExecutionsetValue
          Enumeration type for field EXECUTIONSET
static class IProgramDefinition.JvmValue
          Enumeration type for field JVM
static class IProgramDefinition.LanguageValue
          Enumeration type for field LANGUAGE
static class IProgramDefinition.UsageValue
          Enumeration type for field USAGE
 
Method Summary
 IProgramDefinition.ApiValue getApi()
          Getter for field API
 ICICSEnums.YesNoValue getCedf()
          Getter for field CEDF
 IProgramDefinition.ConcurrencyValue getConcurrency()
          Getter for field CONCURRENCY
 IProgramDefinition.DatalocationValue getDatalocation()
          Getter for field DATALOCATION
 ICICSEnums.YesNoValue getDynamic()
          Getter for field DYNAMIC
 IProgramDefinition.ExeckeyValue getExeckey()
          Getter for field EXECKEY
 IProgramDefinition.ExecutionsetValue getExecutionset()
          Getter for field EXECUTIONSET
 ICICSEnums.YesNoValue getHotpool()
          Getter for field HOTPOOL
 IProgramDefinition.JvmValue getJvm()
          Getter for field JVM
 java.lang.String getJvmclass()
          Getter for field JVMCLASS
 java.lang.String getJvmprofile()
          Getter for field JVMPROFILE
 java.lang.String getJvmserver()
          Getter for field JVMSERVER
 IProgramDefinition.LanguageValue getLanguage()
          Getter for field LANGUAGE
 ICICSEnums.YesNoValue getReload()
          Getter for field RELOAD
 java.lang.String getRemotename()
          Getter for field REMOTENAME
 java.lang.String getRemotesystem()
          Getter for field REMOTESYSTEM
 ICICSEnums.YesNoValue getResident()
          Getter for field RESIDENT
 ICICSEnums.EnablementValue getStatus()
          Getter for field STATUS
 java.lang.String getTransid()
          Getter for field TRANSID
 IProgramDefinition.UsageValue getUsage()
          Getter for field USAGE
 ICICSEnums.YesNoValue getUselpacopy()
          Getter for field USELPACOPY
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime, getCSDGroup, getDescription, getVersion
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName, getObjectType
 

Method Detail

getCedf

ICICSEnums.YesNoValue getCedf()
Getter for field CEDF

Display execution diagnostic facility (EDF) screens

Indicates whether EDF diagnostic screens are displayed. If the program was translated with the EDF option, all EDF screens are displayed; if it was translated with NOEDF, only the program initiation and termination screens appear. CVDA values are:


getDatalocation

IProgramDefinition.DatalocationValue getDatalocation()
Getter for field DATALOCATION

Data location

Indicates whether this module can accept data addresses higher than 16MB. CVDA values are:


getExeckey

IProgramDefinition.ExeckeyValue getExeckey()
Getter for field EXECKEY

Program execution key

The key in which CICS gives control to the program, and determines whether the program can modify CICS-key storage.


getExecutionset

IProgramDefinition.ExecutionsetValue getExecutionset()
Getter for field EXECUTIONSET

API subset restriction type

Specifies whether you want CICS to link to and run a program as if it were running in a remote CICS region.


getLanguage

IProgramDefinition.LanguageValue getLanguage()
Getter for field LANGUAGE

Language

The program language. Options are: ASSEMBLER, C, COBOL, LE370, PLI.

Specify LE370 if the program exploits multi-language support, or if the program has been compiled by a Language Environment-conforming compiler.

In most cases, you do not need to specify the LANGUAGE attribute, because the CICS program manager deduces the correct language and ignores the value you have specified. If the language is not specified, and CICS cannot deduce it, transactions that attempt to use the program will aband with code ALIG.


getReload

ICICSEnums.YesNoValue getReload()
Getter for field RELOAD

Reload new copy

Specifies whether a program control link, load, or XCTL request is to bring in a fresh copy of a program. This attribute does not apply to JVM programs.


getStatus

ICICSEnums.EnablementValue getStatus()
Getter for field STATUS

Enabled status

Indicates whether the module is available for use. CVDA values are:


getUselpacopy

ICICSEnums.YesNoValue getUselpacopy()
Getter for field USELPACOPY

Use program from the link pack area (LPA)

Specifies whether the program is to be used from the link pack area (LPA). This attribute does not apply to JVM programs.


getUsage

IProgramDefinition.UsageValue getUsage()
Getter for field USAGE

Program storage release

Indicates when the storage for this program should be released:


getResident

ICICSEnums.YesNoValue getResident()
Getter for field RESIDENT

Residence status

The residence status of the program. This attribute does not apply to JVM programs.


getRemotename

java.lang.String getRemotename()
Getter for field REMOTENAME

Program name in remote system

(Optional.) Specifies, if the program resides on a remote system, the name by which the program is known in the remote CICS region. If you specify REMOTESYSTEM and omit REMOTENAME, this attribute defaults to the same name as the local name (that is, the program name on this resource definition).


getRemotesystem

java.lang.String getRemotesystem()
Getter for field REMOTESYSTEM

Remote system name

(Optional.) If you want CICS to ship a DPL request to another CICS system, specify the system ID of the remote system. If REMOTENAME is specified then a value must be specified for REMOTESYSTEM. This value must be the name of the connection definition (CONNDEF or IPCONDEF) for the link to the remote system. CICSPlex SM uses this system ID only if the program is part of a resource group that is directly associated with a resource description (via RESINDSC). If the program is being assigned by a resource assignment (RASGNDEF), CICSPlex SM sets the remote system according to the rules, as follows:


getTransid

java.lang.String getTransid()
Getter for field TRANSID

Mirror transaction name for remote attach

If the program is dynamic, this is the default TRANSID used for the distributed program link (DPL) request. If the program is not dynamic, this specifies the name of the transaction you want the remote CICS to attach, and under which it is to run the remote program. If you do not specify a transaction name on the TRANSID attribute, the remote region executes the DPL program under one of the CICS-supplied default mirror transactions.


getUserdata1

java.lang.String getUserdata1()
Getter for field USERDATA1

User data area 1

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata2

java.lang.String getUserdata2()
Getter for field USERDATA2

User data area 2

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata3

java.lang.String getUserdata3()
Getter for field USERDATA3

User data area 3

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getDynamic

ICICSEnums.YesNoValue getDynamic()
Getter for field DYNAMIC

Dynamic routing status

Indicates whether, if the program is the subject of a program-link request, the request can be dynamically routed. CVDA values are:


getConcurrency

IProgramDefinition.ConcurrencyValue getConcurrency()
Getter for field CONCURRENCY

Concurrency status

The concurrency attribute of the installed program definition. The CVDA values are:


getJvm

IProgramDefinition.JvmValue getJvm()
Getter for field JVM

Java virtual machine (JVM) mode

Specifies whether or not the program is a Java program that has to operate under the control of a Java Virtual Machine (JVM).


getJvmclass

java.lang.String getJvmclass()
Getter for field JVMCLASS

Java virtual machine (JVM) class

the main class in a Java program to be run under the control of a JVM. This class name can be overridden using the user-replaceable programs DFHJVMAT.


getHotpool

ICICSEnums.YesNoValue getHotpool()
Getter for field HOTPOOL

Hot pooling status

Specifies whether or not the Java program object is to be run in a preinitialized Language Environment enclave reused by multiple invocations of the program, under control of an H8 TCB. Programs defined with Hot pooling status of YES must also be defined with Concurrency status of THREADSAFE.


getJvmprofile

java.lang.String getJvmprofile()
Getter for field JVMPROFILE

Java virtual machine (JVM) profile

The JVM profile name. The name can be up to eight characters in length. Do not use profile names beginning with DFH, because these characters are reserved for use by CICS.


getApi

IProgramDefinition.ApiValue getApi()
Getter for field API

Application program interfaces

The API attribute of the installed program definition. The API attribute is used for application programs, PLT programs, user replaceable modules and task related user exits. The API attribute is not used for global user exits. CVDA values are:


getJvmserver

java.lang.String getJvmserver()
Getter for field JVMSERVER

Java virtual machine (JVM) server

The JVMSERVER resource to be used by this PROGRAM. The name can be up to eight characters in length. You must specify an EXECKEY of CICS and a Concurrency status of REQUIRED if the PROGRAM uses a JVMSERVER.



Copyright 2008-2009 IBM Corp. All Rights Reserved.