com.ibm.cics.model

Interface IProgram

    • 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:

        • LPA - CICS used a version in either the link pack area (LPA) or the extended link pack area (ELPA).
        • NOTLPA - CICS used a private version.
        • NOTAPPLIC - CICS has not used an LPA version, or a private version of the program.
      • 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:

        • MAP - A map set.
        • PARTITION - A partition set.
        • PROGRAM - An executable program.
      • getDataLocation

        IProgram.DataLocationValue getDataLocation()
        Getter for field DATALOCATION

        Data location

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

        • ANY - Can accept an address above 16MB.
        • BELOW - Requires an address below 16MB.
        • NOTAPPLIC - This option is not available; the program is defined as remote, is a map set, or is a partition set.
      • 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:

        • CICSEXECKEY - The program executes in CICS key and has read and write access to both CICS-key and user-key storage.
        • USEREXECKEY. - The program executes in user key and has write access to user-key storage, but read-only access to CICS key storage.
        • NOTAPPLIC - This option is not available; either the program is defined as remote, or it is a map set or partition set.
      • 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:

        • DPLSUBSET - The program is restricted to the same subset of the CICS API that applies when it is linked to by a distributed program link (DPL) request.
        • FULLAPI - The program is not restricted to the DPL subset of the CICS API; it can use the full API.
        • NOTAPPLIC - This option is not available; either the program is defined as remote, or it is a map set or partition set.
        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:

        • COBOL - OS/VS COBOL
        • COBOLII - Enterprise COBOL or VS COBOL II
        • NOTINIT - The program is defined as a COBOL program, but it has not yet been loaded, so the type cannot be determined.
        • NOTAPPLIC - The program has been loaded and it is not a COBOL program, or the program has not been loaded and it is not defined as a COBOL program.
      • 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.

        • QUASIRENT - The program is defined as being quasi-reeentrant, and is able to run only under the CICS QR TCB.
        • THREADSAFE - The program is defined as threadsafe, and is able to run under whichever TCB is in use when the program is given control. This could be either an open TCB or the CICS QR TCB. The program must be coded to threadsafe standards.
        • REQUIRED - The program is required to run on an open TCB. The type of open TCB used depends on the setting of the Application program interface attribute and the language of the program.
          • For Java programs a T8, J8 or J9 is used. J8 and J9 TCBs are obsolete from CICS Transaction Server 5.1 onwards.
          • For C or C++ XPLINK programs an X8 or X9 is used.
          • For Cobol, Pli, non-xplink C and assembler programs if CICSAPI is set, an L8 TCB is always used as CICS services run in CICS key or USER key regardless of the key of the TCB. If OPENAPI is set, then an L8 or an L9 TCB is used dependent upon the execution key of the program.
          The program must be coded to threadsafe standards.
      • 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:

        • JVM - The program is a Java program that will run in a Java Virtual Machine.
        • NOJVM - The program will execute as a CICS application outside the JVM environment.
        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:
        • LE370 - The program will run with LE370 runtime support.
        • NONLE370 - The program will run with a language specific runtime environment.
        • UNKNOWN - The program environment is unknown due to the fact that the program has not been loaded by CICS, and so its source language cannot be deduced.
        • XPLINK - The program is a C or C++ program which has been compiled using the XPLINK option.
        • NOTAPPLIC - RUNTIME does not apply because the module is a map set, or a partition set. Note that the above values cannot be directly set. They are reported only as a result of a NOJVM value being specified.
      • 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 HOTPOOLING option is obsolete.

      • getJVMProfile

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

        Java virtual machine (JVM) profile name

        This is obsolete from CICS TS Version 5 Release 1. 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.

        • CICSAPI - The program is restricted to use of the CICS application programming interfaces. CICS determines whether the program runs on the quasi-reentrant (QR) TCB, or on another TCB. This depends upon the value of the CONCURRENCY attribute in the PROGRAM resource definition. If the program is defined as threadsafe it may run on whichever TCB, in use by CICS at the time, is determined as suitable.
        • OPENAPI - The program is not restricted to the CICS application programming interfaces. CICS executes the program on its own open TCB dependent upon the value of the EXECKEY attribute in the PROGRAM resource definition. If, while executing a CICS command, CICS requires a switch to the QR TCB, it returns to the open TCB before handing control back to the application program. OPENAPI requires the program to be coded to threadsafe standards and be defined with CONCURRENCY(REQUIRED).
      • 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.

        • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
        • CSDBATCH - The resource was last changed by a DFHCSDUP job.
        • DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
        • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
        • SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
        • AUTOINSTALL - The resource was last autoinstalled.
        • DYNAMIC - The resource was last changed dynamically.
        • CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
        • NOTAPPLIC - This is not applicable for this resource.
      • 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.

        • CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
        • CREATESPI - The resource was installed by an EXEC CICS CREATE command.
        • SYSTEM - The resource was last installed by the CICS system.
        • AUTOINSTALL - The resource was autoinstalled.
        • DYNAMIC - The resource was installed dynamically.
        • GRPLIST - The resource was installed by GRPLIST INSTALL.
        • BUNDLE - The resource was installed by a bundle deployment.
      • 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.

      • getApplicationName

        java.lang.String getApplicationName()
        Getter for field APPLICATION

        Application Name

        The application name of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.

      • getPlatformName

        java.lang.String getPlatformName()
        Getter for field PLATFORM

        Platform Name

        The platform name of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.

      • getOperationName

        java.lang.String getOperationName()
        Getter for field OPERATION

        Operation Name

        The name of the application operation for which this program is defined as an entry point. If this field is not set, this program is not defined as an entry point but may still be part of an application.

      • getMajorVersion

        java.lang.Long getMajorVersion()
        Getter for field APPLMAJORVER

        Major Version

        The major version number of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.

      • getMinorVersion

        java.lang.Long getMinorVersion()
        Getter for field APPLMINORVER

        Minor Version

        The minor version number of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.

      • getMicroVersion

        java.lang.Long getMicroVersion()
        Getter for field APPLMICROVER

        Micro Version

        The micro version number of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.

      • getResidency

        IProgram.ResidencyValue getResidency()
        Getter for field RESIDENCY

        Program residency

        The residence status of the program, indicating whether or not the program is permanently resident in virtual storage once loaded.

Copyright ? 2008-2015 IBM Corp. All Rights Reserved.