com.ibm.cics.model
Interface IProgram

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource, com.ibm.cics.model.meta.ITypedObject

public interface IProgram
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable PROGRAM


Nested Class Summary
static class IProgram.APIStatusValue
          Enumeration type for field APIST
static class IProgram.CEDFStatusValue
          Enumeration type for field CEDFSTATUS
static class IProgram.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class IProgram.COBOLTypeValue
          Enumeration type for field COBOLTYPE
static class IProgram.ConcurrencyValue
          Enumeration type for field CONCURRENCY
static class IProgram.CurrentLocationValue
          Enumeration type for field CURRENTLOC
static class IProgram.DataLocationValue
          Enumeration type for field DATALOCATION
static class IProgram.ExecutionKeyValue
          Enumeration type for field EXECKEY
static class IProgram.ExecutionSetValue
          Enumeration type for field EXECUTIONSET
static class IProgram.HoldStatusValue
          Enumeration type for field HOLDSTATUS
static class IProgram.HotPoolingValue
          Enumeration type for field HOTPOOLING
static class IProgram.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class IProgram.LanguageValue
          Enumeration type for field LANGUAGE
static class IProgram.LPAStatusValue
          Enumeration type for field LPASTAT
static class IProgram.NewcopyStatusValue
          Enumeration type for field COPY
static class IProgram.ProgramTypeValue
          Enumeration type for field PROGTYPE
static class IProgram.RoutingTypeValue
          Enumeration type for field DYNAMSTATUS
static class IProgram.RuntimeValue
          Enumeration type for field RUNTIME
static class IProgram.ShareStatusValue
          Enumeration type for field SHARESTATUS
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 IProgram.APIStatusValue getAPIStatus()
          Getter for field APIST
 java.lang.String getAverageLoadTime()
          Getter for field ALOADTIME
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 IProgram.CEDFStatusValue getCEDFStatus()
          Getter for field CEDFSTATUS
 IProgram.ChangeAgentValue getChangeAgent()
          Getter for field CHANGEAGENT
 java.lang.String getChangeAgentRelease()
          Getter for field CHANGEAGREL
 java.util.Date getChangeTime()
          Getter for field CHANGETIME
 java.lang.String getChangeUserID()
          Getter for field CHANGEUSRID
 IProgram.COBOLTypeValue getCOBOLType()
          Getter for field COBOLTYPE
 IProgram.ConcurrencyValue getConcurrency()
          Getter for field CONCURRENCY
 java.lang.Long getConcurrentUseCount()
          Getter for field RESCOUNT
 IProgram.CurrentLocationValue getCurrentLocation()
          Getter for field CURRENTLOC
 IProgram.DataLocationValue getDataLocation()
          Getter for field DATALOCATION
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 java.lang.String getDSName()
          Getter for field LIBRARYDSN
 java.lang.String getEntryPoint()
          Getter for field ENTRYPOINT
 IProgram.ExecutionKeyValue getExecutionKey()
          Getter for field EXECKEY
 IProgram.ExecutionSetValue getExecutionSet()
          Getter for field EXECUTIONSET
 java.lang.Long getFetchCount()
          Getter for field FETCHCNT
 java.lang.String getFetchTime()
          Getter for field FETCHTIME
 IProgram.HoldStatusValue getHoldStatus()
          Getter for field HOLDSTATUS
 IProgram.HotPoolingValue getHotPooling()
          Getter for field HOTPOOLING
 IProgram.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 java.lang.Long getIntervalUseCount()
          Getter for field USEAGELSTAT
 java.lang.String getJVMClass()
          Getter for field JVMCLASS
 java.lang.String getJVMProfile()
          Getter for field JVMPROFILE
 java.lang.String getJvmserver()
          Getter for field JVMSERVER
 java.lang.Long getJVMUseCount()
          Getter for field PGRJUSECOUNT
 IProgram.LanguageValue getLanguage()
          Getter for field LANGUAGE
 java.lang.Long getLength()
          Getter for field LENGTH
 java.lang.String getLibrary()
          Getter for field LIBRARY
 java.lang.String getLoadingRate()
          Getter for field RLOADING
 java.lang.String getLoadPoint()
          Getter for field LOADPOINT
 IProgram.LPAStatusValue getLPAStatus()
          Getter for field LPASTAT
 java.lang.String getMirrorTransaction()
          Getter for field TRANSID
 java.lang.String getName()
          Getter for field PROGRAM
 java.lang.Long getNewcopyCount()
          Getter for field NEWCOPYCNT
 IProgram.NewcopyStatusValue getNewcopyStatus()
          Getter for field COPY
 IProgram.ProgramTypeValue getProgramType()
          Getter for field PROGTYPE
 java.lang.String getRemoteName()
          Getter for field REMOTENAME
 java.lang.String getRemoteSystem()
          Getter for field REMOTESYSTEM
 java.lang.String getRemovalRate()
          Getter for field RREMOVAL
 java.lang.Long getRemoveCount()
          Getter for field REMOVECNT
 IProgram.RoutingTypeValue getRoutingType()
          Getter for field DYNAMSTATUS
 java.lang.Long getRPLNumber()
          Getter for field RPLID
 IProgram.RuntimeValue getRuntime()
          Getter for field RUNTIME
 IProgram.ShareStatusValue getShareStatus()
          Getter for field SHARESTATUS
 ICICSEnums.EnablementValue getStatus()
          Getter for field STATUS
 java.lang.Long getUseCount()
          Getter for field USECOUNT
 java.lang.String getUseRate()
          Getter for field RUSE
 java.lang.String getUsesPerFetch()
          Getter for field USEFETCH
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getObjectType
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Getter for field PROGRAM

Program name

The name of the program.

Specified by:
getName in interface ICICSObject

getLanguage

IProgram.LanguageValue getLanguage()
Getter for field LANGUAGE

Language

The language in which the program is written (COBOL, C, PLIPL1 (for PLI or PL1), LE370, LEVSE, ASSEMBLER, or JAVA).

A value of NOTDEFINED is returned if the language was not specified in the resource definition. When the program is eventually loaded, the language is deduced and this value will then be used.

A value of NOTAPPLIC is returned for remote programs, maps and partition sets.


getNewcopyCount

java.lang.Long getNewcopyCount()
Getter for field NEWCOPYCNT

Number of NEWCOPY requests issued

The number of times a NEWCOPY request has been issued against this program during the current CICS statistics interval.


getUseCount

java.lang.Long getUseCount()
Getter for field USECOUNT

Total number of times program was executed

The total number of times the program has been executed in the current CICS session. For CICS TS 3.2 and later regions, this field shows a use count for Java programs as well as for other types of program. For earlier regions, Java programs do not have a use count in this field. A value of N/A is returned for remote programs.


getIntervalUseCount

java.lang.Long getIntervalUseCount()
Getter for field USEAGELSTAT

Number of times program was used since last reset

The number of times access to the program was requested during the current CICS statistics interval.


getConcurrentUseCount

java.lang.Long getConcurrentUseCount()
Getter for field RESCOUNT

Number of times program currently accessed

The number of separate invocations of this program that are currently taking place. A value of N/A means it is a remote program, or a Java program that runs in a JVM.


getFetchCount

java.lang.Long getFetchCount()
Getter for field FETCHCNT

Number of times program loaded into storage

The number of times a copy of the program was loaded from the DFHRPL or LIBRARY concatenation into storage during the current CICS statistics interval.


getStatus

ICICSEnums.EnablementValue getStatus()
Getter for field STATUS

Enabled status

The enabled status of the program, which indicates whether it is available for use.

Input Values: ENABLED, DISABLED


getHoldStatus

IProgram.HoldStatusValue getHoldStatus()
Getter for field HOLDSTATUS

Hold status

Indicates whether a copy of the program is currently loaded with the HOLD option (HOLD or NOHOLD). A value of NOTAPPLIC means either the program is not currently loaded, or it is a remote program.


getShareStatus

IProgram.ShareStatusValue getShareStatus()
Getter for field SHARESTATUS

Share status

The shared status of the program, which determines whether the next new copy loaded will be a shared version (SHARED) or a private version (PRIVATE). A value of NOTAPPLIC is returned for remote programs, or Java programs that run in a JVM.

Input Values: SHARED, PRIVATE


getLength

java.lang.Long getLength()
Getter for field LENGTH

Program length

The length of the program in bytes. A value of 0 means the program has not been loaded in the current CICS session. A value of N_A means it is a remote program, or a Java program that runs in a JVM.


getRPLNumber

java.lang.Long getRPLNumber()
Getter for field RPLID

Data set offset number

The offset into the DFHRPL DD program library concatenation.

Note: The offset values begin with zero for the first partitioned data set in the concatenation.


getLPAStatus

IProgram.LPAStatusValue getLPAStatus()
Getter for field LPASTAT

Link pack area (LPA) status

Indicates where the most recently loaded copy of the program was taken from:


getCEDFStatus

IProgram.CEDFStatusValue getCEDFStatus()
Getter for field CEDFSTATUS

CEDF status

The CEDF status of the program, which determines whether or not CEDF actions are enabled (CEDF or NOCEDF). A value of NOTAPPLIC is returned for remote programs, maps and partition sets.

Input Values: CEDF, NOCEDF


getProgramType

IProgram.ProgramTypeValue getProgramType()
Getter for field PROGTYPE

Program type

The type of program, as one of the following:


getDataLocation

IProgram.DataLocationValue getDataLocation()
Getter for field DATALOCATION

Data location

Indicates whether the program can accept data addresses higher than 16MB:


getFetchTime

java.lang.String getFetchTime()
Getter for field FETCHTIME

Total time for all program fetches

The total time taken to perform all fetches of the program during the current CICS statistics interval.


getRemoveCount

java.lang.Long getRemoveCount()
Getter for field REMOVECNT

Number of times removed by program compression

The number of times a copy of this program has been removed from storage by the Dynamic Program Storage Compression (DPSC) facility during the current CICS statistics interval.


getExecutionKey

IProgram.ExecutionKeyValue getExecutionKey()
Getter for field EXECKEY

Program execution key

The access key in which the program is executing:


getExecutionSet

IProgram.ExecutionSetValue getExecutionSet()
Getter for field EXECUTIONSET

API subset restriction type

Indicates whether the program is restricted to the API subset when running in the local CICS system:

Input Values: DPLSUBSET, FULLAPI


getEntryPoint

java.lang.String getEntryPoint()
Getter for field ENTRYPOINT

Program entry point

The entry point address of the most recently loaded copy of the program.

The high order bit of the address (hexadecimal 80) is set on if the program is defined with AMODE=31. A value of FF000000 means the program is not currently in use, or is a remote program, or is a Java program that runs in a JVM.


getLoadPoint

java.lang.String getLoadPoint()
Getter for field LOADPOINT

Program load point

The load address of the most recently loaded copy of the program. A value of FF000000 means the program is not currently in use, or is a Java program that runs in a JVM.


getCOBOLType

IProgram.COBOLTypeValue getCOBOLType()
Getter for field COBOLTYPE

COBOL type

The type of COBOL being used, as one of the following:


getRemoteName

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

Program name in remote system

The name by which the program is known in the remote CICS system, if a remote system was defined. If this field is blank, no remote system was defined.


getRemoteSystem

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

Remote system name

The name of a remote CICS system to which a link request for this program is shipped. If this field is blank, no remote system was defined.


getMirrorTransaction

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

Mirror transaction name for remote attach

The name of the server transaction the remote system is to attach when the program is defined as remote or dynamic. If this field is blank, the program is not defined as remote.


getCurrentLocation

IProgram.CurrentLocationValue getCurrentLocation()
Getter for field CURRENTLOC

CICS DSA in which current copy is located

The location of that copy of the program that is currently resident in storage, if any (CDSA, LPA, ECDSA, EUDSA, ERDSA, ELPA, UDSA, ESDSA, RDSA, or SDSA). A value of NOCOPY means no copy of the program is currently loaded.


getNewcopyStatus

IProgram.NewcopyStatusValue getNewcopyStatus()
Getter for field COPY

Newcopy required status

The COPY status of the program, which determines whether or not a new copy of the program is required. A value of N/A is returned for CICS releases that do not support this field.


getRoutingType

IProgram.RoutingTypeValue getRoutingType()
Getter for field DYNAMSTATUS

Dynamic routing type

The DYNAMIC routing status of the program. If DYNAMIC then it can be dynamically routed by the CICS dynamic routing exit. If NOTDYNAMIC then it cannot be routed by the CICS dynamic routing exit.


getConcurrency

IProgram.ConcurrencyValue getConcurrency()
Getter for field CONCURRENCY

Concurrency option

Specifies the concurrency attribute of the program.


getRuntime

IProgram.RuntimeValue getRuntime()
Getter for field RUNTIME

Runtime environment information

Specifies information about the Runtime environment for a program. Users may SET values of:

If a value of NOJVM is specified, then this will be resolved to one of the following reported settings, based on the current application state:


getJVMClass

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

Java virtual machine class

This is the hyperlink to the PROGRAMJ panel, which details the contents of the JVM Class specification, and allows its modification.


getHotPooling

IProgram.HotPoolingValue getHotPooling()
Getter for field HOTPOOLING

Hot pooling status

The Hot Pooling status of the program.


getJVMProfile

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

Java virtual machine (JVM) profile name

The name of the JVM profile. The default value is DFHJVMPR.


getAverageLoadTime

java.lang.String getAverageLoadTime()
Getter for field ALOADTIME

Average load time

The mean time taken for program load requests.


getUsesPerFetch

java.lang.String getUsesPerFetch()
Getter for field USEFETCH

Average number of program uses per fetch

The average number of program uses per fetch.


getLoadingRate

java.lang.String getLoadingRate()
Getter for field RLOADING

Rate of program loading

The rate at which the program is loaded.


getRemovalRate

java.lang.String getRemovalRate()
Getter for field RREMOVAL

Rate of program removal

The rate at which the program is removed.


getUseRate

java.lang.String getUseRate()
Getter for field RUSE

Rate of program use

The rate at which the program is used.


getJVMUseCount

java.lang.Long getJVMUseCount()
Getter for field PGRJUSECOUNT

Number of times JVM program used since last reset

If this program is a Java program, the number of times it was accessed during the current CICS statistics interval.


getAPIStatus

IProgram.APIStatusValue getAPIStatus()
Getter for field APIST

API status

Specifies the application programming interface restriction status.


getLibrary

java.lang.String getLibrary()
Getter for field LIBRARY

LIBRARY name

The name of the LIBRARY resource from which this program was loaded. This will be blank if the program has not been loaded, or if the LPASTATUS is LPA (indicating that the program has been loaded from the LPA).


getDSName

java.lang.String getDSName()
Getter for field LIBRARYDSN

Load data set name

The name of the data set from which this program was loaded. This will be blank if the program has not been loaded, or if the LPASTATUS is LPA (indicating that the program has been loaded from the LPA).


getChangeUserID

java.lang.String getChangeUserID()
Getter for field CHANGEUSRID

Last modification user ID

The user ID that made the last modification to the resource definition.


getChangeAgent

IProgram.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENT

Last modification agent

The change agent identifier that made the last modification.


getChangeAgentRelease

java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGREL

Last modification agent release

The CICS release level of the agent that made the last modification to the resource definition.


getInstallAgent

IProgram.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENT

Installation agent

The install agent identifier that made the installation.


getChangeTime

java.util.Date getChangeTime()
Getter for field CHANGETIME

Last modification time

The local date and time when the definition was last changed.


getDefineSource

java.lang.String getDefineSource()
Getter for field DEFINESOURCE

Source of the resource definition

The source of the definition, depending on which agent made the last change.


getDefineTime

java.util.Date getDefineTime()
Getter for field DEFINETIME

Creation time

The local date and time when the resource definition record was created on DFHCSD or EYUDREP.


getInstallUserID

java.lang.String getInstallUserID()
Getter for field INSTALLUSRID

Installation user ID

The user ID that installed the resource definition.


getInstallTime

java.util.Date getInstallTime()
Getter for field INSTALLTIME

Installation time

The local date and time when the definition was installed.


getBasdefinever

java.lang.Long getBasdefinever()
Getter for field BASDEFINEVER

BAS resource definition version

The BAS version number of this definition.


getJvmserver

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

Java virtual machine (JVM) server

The name of the JVMSERVER resource used by this PROGRAM.



Copyright © 2008-2012 IBM Corp. All Rights Reserved.