Pathway/iTS Web Client Programming Manual (H06.03+, J06.03+)

Manuals Brands HP Manuals Server HP Integrity NonStop H-Series

Table Of Contents

HP NonStop

Pathway/iTS Web Client

Programming Manual

Abstract

This manual describes how to convert SCREEN COBOL requesters to web clients and

explains how to build and deploy those clients. It also provides the information Java

developers and web designers need to modify and enhance the Java and HTML

portions of the converted clients.

Product Version

Pathway/iTS 1.1

Supported Release Version Updates (RVUs)

This publication supports J06.03 and all subsequent J-series RVUs and H06.03 and all

subsequent H-series RVUs, until otherwise indicated by its replacement publications.

Part Number Published

520270-003 May 2008

Summary of content (247 pages)

PAGE 1

HP NonStop Pathway/iTS Web Client Programming Manual Abstract This manual describes how to convert SCREEN COBOL requesters to web clients and explains how to build and deploy those clients. It also provides the information Java developers and web designers need to modify and enhance the Java and HTML portions of the converted clients. Product Version Pathway/iTS 1.1 Supported Release Version Updates (RVUs) This publication supports J06.03 and all subsequent J-series RVUs and H06.
PAGE 2

Document History Part Number Product Version Published 426746-001 Pathway/iTS 1.0 October 2000 520270-001 Pathway/iTS 1.0 Update June 2001 520270-002 Pathway/iTS 1.1 May 2007 520270-003 Pathway/iTS 1.
PAGE 3

Legal Notices © Copyright 2008 Hewlett-Packard Development Company L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice.
PAGE 4
PAGE 5

HP NonStop Pathway/iTS Web Client Programming Manual Index Examples Figures Tables Legal Notices What’s New in This Manual vii Manual Information vii New and Changed Information About This Manual xi Who Should Read This Manual Related Documentation xi Notation Conventions xiii vii xi 1.
PAGE 6

2. How to Compile, Build, and Maintain a Pathway/iTS Web Client (continued) Contents 2. How to Compile, Build, and Maintain a Pathway/iTS Web Client (continued) 7. Deploy the Web Client 2-9 Deploy the Web Client on an OSS Environment 2-9 Deploy the Web Client on a Windows Environment 2-11 8. Customize the Screens 2-12 Copy the HTML Files to be Customized 2-12 Modify the HTML Files 2-13 Redeploy Customized HTML Files 2-13 9. Specify the Port Number of the Router Process 2-13 10.
PAGE 7

5. SCREEN COBOL-to-Web Conversion Mappings (continued) Contents 5. SCREEN COBOL-to-Web Conversion Mappings (continued) Mappings to User HTML Pages 5-7 6.
PAGE 8

7. Introduction to Pathway/iTS 1.1 Contents 7. Introduction to Pathway/iTS 1.1 Architecture of Pathway/iTS 1.1 7-2 SCOBOL Verbs and Special Register 7-3 Web Clients in Pathway/iTS 1.1 7-4 Difference Between Pathway/iTS 1.0 and Pathway/iTS 1.1 7-4 Server Process Opener and Timeouts on Send to Servers 7-4 TCP Checkpoint Strategy 7-4 Special Registers 7-5 FREEZE SERVER Command Changes 7-6 Statistics Collected by Pathway/iTS 1.1 7-7 Fault Tolerance in Pathway/iTS 1.1 7-7 Error Handling in Pathway/iTS 1.
PAGE 9

Figures (continued) Contents Figures (continued) Figure 1-2. Figure 7-1. Run-Time Environment for a Pathway/iTS Web Client Architecture of Pathway/iTS 1.1 7-2 1-3 Tables Table B-1.
PAGE 10

Contents HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 vi
PAGE 11

What’s New in This Manual Manual Information HP NonStop Pathway/iTS Web Client Programming Manual Abstract This manual describes how to convert SCREEN COBOL requesters to web clients and explains how to build and deploy those clients. It also provides the information Java developers and web designers need to modify and enhance the Java and HTML portions of the converted clients. Product Version Pathway/iTS 1.1 Supported Release Version Updates (RVUs) This publication supports J06.
PAGE 12

What’s New in This Manual • Product Changes in G06.27 Added these error messages: • • • • • • • • • • • • • 3115 on page A-8 3231 on page A-11 3246 on page A-11 3247 on page A-12 3248 on page A-12 3249 on page A-13 3250 on page A-13 3251 on page A-14 3252 on page A-14 3253 on page A-15 3308 on page A-18 3312 on page A-19 3313 on page A-19 Product Changes in G06.
PAGE 13

What’s New in This Manual • Corrections and Enhancements to the Manual Section 5: SCREEN COBOL-to-Web Conversion Mappings • • • Added a description of the Initial page in Initial Page on page 5-2. Modified the name of the starting page file from name_PAGE1.html to name_START.html in Starting Page on page 5-2.
PAGE 14

What’s New in This Manual Corrections and Enhancements to the Manual HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 x
PAGE 15

About This Manual This manual describes how to convert SCREEN COBOL requesters to web clients and explains how to build and deploy those clients. It also provides the information Java developers and web designers need to modify and enhance the Java and HTML portions of the converted clients.
PAGE 16

Related Documentation About This Manual These manuals may be useful: Pathway/iTS SCUP Reference Manual Pathway/iTS SCREEN COBOL Reference Manual Pathway/iTS TCP and Terminal Programming Guide Pathway/iTS System Management Manual NonStop™ TS/MP System Management Manual Pathway/XM System Management Manual Pathway/iTS Management Programming Manual Pathway Products Glossary Operator Messages Manual Describes the utility program that enables SCREEN COBOL application programmers to control and manipulate
PAGE 17

About This Manual Notation Conventions Notation Conventions Hypertext Links Blue underline is used to indicate a hypertext link within text. By clicking a passage of text with a blue underline, you are taken to the location described. For example: This requirement is described under Backup DAM Volumes and Physical Disk Drives on page 3-2. General Syntax Notation The following list summarizes the notation conventions for syntax presentation in this manual. UPPERCASE LETTERS.
PAGE 18

About This Manual General Syntax Notation | Vertical Line. A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example: INSPECT { OFF | ON | SAVEABEND } … Ellipsis. An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. For example: M address-1 [ , new-value ]... [ - ] {0|1|2|3|4|5|6|7|8|9}...
PAGE 19

Notation for Messages About This Manual Notation for Messages The following list summarizes the notation conventions for the presentation of displayed messages in this manual. Bold Text. Bold text in an example indicates user input typed at the terminal. For example: ENTER RUN CODE ?123 CODE RECEIVED: 123.00 The user must press the Return key after typing the input. Nonitalic text. Nonitalic letters, numbers, and punctuation indicate text that is displayed or returned exactly as shown.
PAGE 20

About This Manual Change Bar Notation % Percent Sign. A percent sign precedes a number that is not in decimal notation. The %þnotation precedes an octal number. The %Bþnotation precedes a binary number. The %Hþnotation precedes a hexadecimal number. For example: %005400 P=%p-register E=%e-register Change Bar Notation Change bars are used to indicate substantive differences between this manual and its preceding version.
PAGE 21

1 Introduction to Pathway/iTS Web Clients The web client feature of HP NonStop Pathway/iTS lets you convert a SCREEN COBOL application (a group of related compiled program units within an object library) to a web client and then build and deploy the resulting client in a Pathway environment. The converted web client consists of a combination of Java code and HTML pages. These can be deployed on any web server hosted on the HP NonStop Kernel operating system.
PAGE 22

Development Process for Web Clients Introduction to Pathway/iTS Web Clients Development Process for Web Clients The process of creating a Pathway/iTS web client is shown in Figure 1-1. To convert a SCREEN COBOL object program to a web client, you invoke the Pathway/iTS converter utility through the CONVERT command in the SCREEN COBOL Utility Program (SCUP). The converter scans the compiled SCREEN COBOL object code and generates an equivalent web client. Figure 1-1.
PAGE 23

Run-Time Environment for Web Clients Introduction to Pathway/iTS Web Clients Optionally, before deployment you can customize the converted HTML pages by using standard web publishing tools. Run-Time Environment for Web Clients The run-time environment for a Pathway/iTS web client is shown in Figure 1-2. Figure 1-2.
PAGE 24

Introduction to Pathway/iTS Web Clients • • • • • • • Router Process HTML screen interaction classes, which define the attributes and structures associated with SCREEN COBOL screen fields and the SCREEN COBOL statements associated with displaying and accepting screens. Data-type classes, which define the storage and casting rules associated with SCREEN COBOL alphanumeric (PIC X), numeric integer (PIC 9), and numeric non-integer (PIC 9P and PIC 9V) data types.
PAGE 25

Introduction to Pathway/iTS Web Clients Gateway Threads that handles a web client is configured with its FILE attribute pointing to a router process. Each such TERM object sends a message to the router process indicating that it is available to service a connection. When a client requests a connection, the request is sent to the router and the router passes the client information to the TCP.
PAGE 26

Introduction to Pathway/iTS Web Clients Pathway/iTS 1.1 The SCUP and Web client components of Pathway/iTS 1.1 product are changed to support these functionalities. For compatibility reasons, Pathway/iTS 1.1 package includes PATHTCP3, the legacy TCP component. For more information, see Section 7, Introduction to Pathway/iTS 1.1.
PAGE 27

2 How to Compile, Build, and Maintain a Pathway/iTS Web Client This section describes the steps you need to take to convert a SCREEN COBOL program into a Pathway/iTS web client and to compile, build, deploy, and maintain the resulting web client. The steps are: 1. Prepare the SCREEN COBOL Object File 2. Create a Configuration File 3. Run the Converter 4. Modify Java or SCREEN COBOL Code as Needed 5. Run PROFDBM to Set Up the User Profile Database 6. Build the Converted Client 7. Deploy the Web Client 8.
PAGE 28

How to Compile, Build, and Maintain a Pathway/iTS Web Client 1. Prepare the SCREEN COBOL Object File 1. Prepare the SCREEN COBOL Object File Before you run the converter, organize the SCREEN COBOL object (POBJ) file so that repeated conversions can be done easily. First, copy the SCREEN COBOL object file to be converted to the desired volume and subvolume. If the SCREEN COBOL object program has its symbols stripped, rebuild the object file with symbols.
PAGE 29

How to Compile, Build, and Maintain a Pathway/iTS Web Client 3. Run the Converter Example 2-1. Sample Configuration File for mycfg [Screen Section] Background = mylogo.gif; Foreground = Black; Font Type = Courier; Font Size = 12; [Convert Environment] Java Location = \system.$java.appa; HTML Location = \system.$html.
PAGE 30

How to Compile, Build, and Maintain a Pathway/iTS Web Client 4. Modify Java or SCREEN COBOL Code as Needed This command converts version 1 of all the program units in the Inventory application (stored in invy* object files) and generates the equivalent Java source and HTML files. The converted files are created in the subvolumes specified in the configuration file mycfg. The look and feel of the generated HTML files are based on the values specified in the Screen Section of the configuration file.
PAGE 31

How to Compile, Build, and Maintain a Pathway/iTS Web Client 6. Build the Converted Client 6. Build the Converted Client You can build (compile) the converted client either on the NonStop system under the Open System Services (OSS) environment of the NonStop Kernel operating system or on another machine running the Windows NT operating system. Doing this involves three steps: 1. Set up the build environment 2. Transfer files to the build environment (if the build environment is Windows NT) 3.
PAGE 32

How to Compile, Build, and Maintain a Pathway/iTS Web Client Set Up the Build Environment in a Windows Environment application-home is the full path name of the OSS directory from which the application will be run. makefile-name is the name of the make file to be created that is used when building and running the application int he OSS environment. JMAKENV does these: • • • • • Creates a directory named application-home/build.
PAGE 33

How to Compile, Build, and Maintain a Pathway/iTS Web Client Set Up the Build Environment in a Windows Environment This utility uses the MAP file that is created at the time of conversion to generate the build environment. The MAP file is created at the same location ($volume.subvolume) from which the CONVERT command was run. The MAP file name is composed of the first four or five SCOBOL object file characters plus the characters MAP.
PAGE 34

How to Compile, Build, and Maintain a Pathway/iTS Web Client • Build (Compile) the Application in an OSS Environment Set the transfer mode to ASCII . 3. Transfer JGETFILE then exit the FTP session using the commands ftp> ASCII ftp> get JGETFILE JGETFILE.BAT ftp> bye 4. When JGETFILE.
PAGE 35

How to Compile, Build, and Maintain a Pathway/iTS Web Client Build (Compile) the Application in a Windows Environment OUTDIR = $(APPHOME)\bin WEBROOT = /usr/tandem/webserver/root JAVAC = Javac -d $(OUTDIR) .SUFFIXES: .java.class PROGRAM_FILES = abc.java \ xyz.java \ main.java HTML_FILES = start.html \ Ctrl.html GIF_FILES = background.gif all: $(PROGRAM_FILES) clean: del /f/q $(BUILDHOME)\*.class .java.
PAGE 36

How to Compile, Build, and Maintain a Pathway/iTS Web Client Deploy the Web Client on an OSS Environment makefile-name is the name of the make file generated by JMAKENV path-name is the relative pathname (under web-root) from which the web pages are served. To deploy the sample application, execute the make file with this command: make -f invymk.
PAGE 37

How to Compile, Build, and Maintain a Pathway/iTS Web Client Deploy the Web Client on a Windows Environment Additional options available in the make file are as: • Publish only the HTML files from /usr/test/inventory/build -f invymk.mk DEPLOY=testapp html • Publish only the class files from /usr/test/inventory/bin -f invymk.mk DEPLOY=testapp class • Delete all the class files from /usr/test/inventory/bin -f invymk.
PAGE 38

How to Compile, Build, and Maintain a Pathway/iTS Web Client 8. Customize the Screens hostname is the IP address or name of the NonStop server where the application is to be deployed user-ID is the valid user ID on the NonStop server password is the password for the user ID. application-home is the full path name of the OSS directory where the application is to be deployed. This directory should be subdirectory to the root directory of the web server.
PAGE 39

How to Compile, Build, and Maintain a Pathway/iTS Web Client Modify the HTML Files Modify the HTML Files Using a standard web editor, open the HTML files, make any modifications, and save the file in the directory. You might also want to save the modified file in your source change control database for future use. Redeploy Customized HTML Files Once the pages are changed, they need to be deployed again. Use ftp to put the files back into a OSS deployment directory. 1.
PAGE 40

How to Compile, Build, and Maintain a Pathway/iTS Web Client 10. Configure Pathway Servers for User Profiles and User Conversion Routines port-num is the TCP/IP port number assigned to this application. This number must match the port number specified when the router process was started, as described in the Pathway/iTS System Management Manual.
PAGE 41

How to Compile, Build, and Maintain a Pathway/iTS Web Client • • 11. Tune the Application for Performance by Changing the Session-Length Parameter Accept day/date/time operations User conversion routines These tasks are delegated to the Pathway/iTS web gateway requester threads under the control of the TCP. Each task involves one complete socket communication cycle (a write and a read) or one I/O operation in a session.
PAGE 42

How to Compile, Build, and Maintain a Pathway/iTS Web Client 12. Maintain the Client Example 2-2. Sample CONTROL.html File Control Frame PAGE 43
How to Compile, Build, and Maintain a Pathway/iTS Web Client Modify Java Source Code Only 2. Build the converted application. 3. Discard the generated HTML files and copy the previously customized HTML files to the /usr/test/inventory/bin directory. 4. Deploy and test the application.

PAGE 44

How to Compile, Build, and Maintain a Pathway/iTS Web Client Modify Java Source Code Only HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 2- 18

PAGE 45

3 Logon Security and User Profiles This section describes the logon security and user profile features presented to the user whenever a Pathway/iTS web client is first started. It also describes how to set up the user profile database. Logon Security Whenever an end user opens the browser and goes to the URL for a Pathway/iTS web client application, a logon screen may be displayed, if required. This screen requires the user to enter a user name and password and a profile name.

PAGE 46

Actions of the Web Client Logon Security and User Profiles Actions of the Web Client If the logon is successful (that is, if the end user enters a valid user name/password combination), the client application begins to run. However, before the browser displays the starting page of the client application, the application communicates with the host NonStop to retrieve information associated with the profile entered by the end user.

PAGE 47

Logon Security and User Profiles User Profile Options in the Control File The TERMINAL-PRINTER and LOGICAL-TERMINAL-NAME fields correspond to the SCREEN COBOL special registers of the same names. The five USER-PROFILE-n fields are new special registers in the applet; these fields have no corresponding special registers in SCREEN COBOL programs. Java definitions of the special registers are given under Special-Register Classes on page 6-120.

PAGE 48

User Profile Options in the Control File Logon Security and User Profiles Parameter Values Description userAuthenticate=true getProfile = true Specifies that the user must enter a valid Guardian user name, password, and the profile name. The user is authenticated and the profile data from the profile server is retrieved.

PAGE 49

Logon Security and User Profiles Use the PROFDBM Utility Use the PROFDBM Utility The user profile database manager (PROFDBM) utility allows you to add, update, search for, and delete records in the USERPROF database. Before using PROFDBM, create the database as: TACL> FUP CREATE USERPROF, TYPE K, REC 248, KEYLEN 16 Note. You must use the name USERPROF for this database; do not use any other name.

PAGE 50

Logon Security and User Profiles Configure the User Profile Server Class Search for a Record To search for an existing record in the database: 1. Enter the number 3. 2. When prompted, enter the user profile name for the record and press ENTER. 3. PROFDBM displays the current values of all the special registers in that record. A blank after the equals sign for a register indicates a null value. 4. After the values are displayed, PROFDBM prompts you to select another command.

PAGE 51

Logon Security and User Profiles Configure the User Profile Server Class Note. For performance tuning in large applications, you might want to change some of the specified configuration values later.

PAGE 52

Logon Security and User Profiles Configure the User Profile Server Class HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 3 -8

PAGE 53

4 User-Written User Conversion Procedures for Web Clients If the SCREEN COBOL application you are converting to a web client includes USER CONVERSION clauses and user-written user conversion procedures, Pathway/iTS supports your existing pTAL user conversion routines running on a NonStop. User conversion procedures used with web clients are bound to a special user conversion server class called USER-LIB-SERVER. This server class is then configured to run in the Pathway environment.

PAGE 54

User-Written User Conversion Procedures for Web Clients Build Your User Conversion Library Build Your User Conversion Library Assuming that the appropriate SLIB, ILIB, and TLIB files are in place and your user conversion object file has been compiled without errors, build the user conversion library, binding it to the USER-LIB-SERVER server class, by invoking the nld utility from the TACL prompt as: NLD user-conversion-object $volume.ZPITS.

PAGE 55

User-Written User Conversion Procedures for Web Clients Configure the User Conversion Server Class SET SERVER TMF ON ADD SERVER USER-LIB-SERVER where scmyuser is the program file name you specified when you built your user conversion library. If you are using a PATHCOM configuration file, also include this command in the list of SET SERVER commands: SET SERVER PROCESSTYPE GUARDIAN Note. The name of the server class specified in the ADD SERVER command must be USER-LIB-SERVER.

PAGE 56

User-Written User Conversion Procedures for Web Clients Configure the User Conversion Server Class HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 4 -4

PAGE 57

5 SCREEN COBOL-to-Web Conversion Mappings This section describes the structure and content of a Pathway/iTS Web client as generated by the converter invoked by the SCUP CONVERT command. It also describes how the elements of the SCREEN COBOL program map into the corresponding elements of the client Java and HTML code. The information in this section can be useful to you if you are modifying portions of the Java or HTML code after conversion.

PAGE 58

SCREEN COBOL-to-Web Conversion Mappings Components of the Web Client Components of the Web Client For each SCREEN COBOL application, the converter generates these Java classes and HTML files: • • • • • • Main Java applet Starting page Initial page Control page Java classes for the program units User HTML pages for the Screen Sections Main Java Applet The main applet is contained in a file named initprog_MAINAPP.

PAGE 59

SCREEN COBOL-to-Web Conversion Mappings Control Page Control Page Each converted SCREEN COBOL application is managed through a control page. This HTML page is loaded into a control frame that is created by the starting page. The control page contains a MainApp applet. This page is not visible to the end user. It remains active throughout the execution of the application. The name of the control page is derived from the user-specified INITIAL program unit followed by _CONTROL.

PAGE 60

SCREEN COBOL-to-Web Conversion Mappings Mappings to Java Classes methods defined in the ScobolType base class in the Pathway/iTS Java import package, as described in Section 6, Java Import Package Reference. The name of the nested Java class is derived by prefixing the name of the group item with c_. Each data item in the Working-Storage Section is mapped to a Java object. Hyphens in the SCREEN COBOL names are replaced by underscores in the Java names.

PAGE 61

SCREEN COBOL-to-Web Conversion Mappings Mappings to Java Classes Conversion of Paragraphs Each program unit class has a method named eXecute. This method provides the starting point for executing that class. Each paragraph in the SCREEN COBOL program is converted to a method in the Java code. The names of these methods are derived from the names of the corresponding paragraphs, with hyphens replaced by underscores.

PAGE 62

Mappings to Java Classes SCREEN COBOL-to-Web Conversion Mappings • • In PROCESS-PARA, the MOVE SPACES statement is converted to calls to the setSpaces() methods in the FIRST_NAME and LAST_NAME data objects. To display the NAME-SCREEN base screen, the converted code invokes the displayBase method in the HTMLHandler object, passing the name of the related HTML file.

PAGE 63

Mappings to User HTML Pages SCREEN COBOL-to-Web Conversion Mappings For example, suppose that these declarations appear in the SCREEN COBOL source code: WORKING-STORAGE SECTION. 01 WS-ITEM1 PIC 9(4) VALUE 4444. 01 WS-ITEM2 PIC 9(4) VALUE 8888. SCREEN SECTION. ... 05 SCR-ITEM1 AT 10,10 PIC 9(4) FROM WS-ITEM1 TO WS-ITEM2. Then this statement will display 4444 on the screen: DISPLAY SCR-ITEM1. This statement will move a value to WS-ITEM2 only when it is changed on the screen: ACCEPT SCR-ITEM1 UNTIL F1.

PAGE 64

SCREEN COBOL-to-Web Conversion Mappings Mappings to User HTML Pages Example 5-7 shows a sample Screen Section in a SCREEN COBOL program. Example 5-7. SCREEN COBOL Screen Section 01 NAME-SCREEN BASE SIZE 24, 80. 05 FILLER AT 05, 10 05 EMP-FIRST-NAME AT 05, 30 05 FILLER AT 10, 10 05 EMP-LAST-NAME AT 10, 30 05 OV-AREA AREA AT 12, 10 SIZE VALUE "ENTER FIRST NAME". PIC X(10) USING FIRST-NAME. VALUE "ENTER LAST NAME". PIC X(30) USING LAST-NAME. 5, 50 Example 5-8 illustrates the corresponding HTML code.

PAGE 65

6 Java Import Package Reference This section defines the public classes and methods in the Pathway/iTS Java import package, pathway.its. This package enables Java-based clients to interact with Pathway applications.

PAGE 66

Java Import Package Reference Host Connectivity Classes Host Connectivity Classes The host connectivity (gateway) classes define the connectivity protocol with the host NonStop and also delegate certain host processing on behalf of the clients. Class Gateway The Gateway class encapsulates the connectivity protocol with the host NonStop and also delegates certain host processing on behalf of the clients. Package pathway.its Syntax public pathway.its.

PAGE 67

Class Gateway Java Import Package Reference Delegation Methods abortTransaction() Aborts the current transaction on the NonStop; equivalent to the SCREEN COBOL ABORTTRANSACTION statement. acceptDate() Gets the NonStop date; equivalent to the SCREEN COBOL ACCEPT DATE statement. acceptDay() Gets the NonStop Julian day; equivalent to the SCREEN COBOL ACCEPT DAY statement. acceptTime() Gets the NonStop time; equivalent to the SCREEN COBOL ACCEPT TIME statement.

PAGE 68

Class Gateway Java Import Package Reference Parameters hostAddress The TCP/IP host name for the NonStop (the n.n.n.n form is also valid) port The TCP/IP port number on which the router process is configured Method abortTransaction Purpose Aborts a transaction on the NonStop on behalf of this client. Syntax public void abortTransaction () throws ScobolTxnException Description Equivalent to the SCREEN COBOL ABORT-TRANSACTION statement. Method acceptDate Purpose Gets the date from the NonStop.

PAGE 69

Class Gateway Java Import Package Reference Syntax public void acceptDay (ScobolType day, boolean yyyyddd) throws ScobolTxnException Description Equivalent to the SCREEN COBOL ACCEPT DAY statement. Parameters day The object that will receive the Julian day. yyyyddd If true, the day will be returned in yyyyddd format; otherwise, it will be in yyddd format. Method acceptTime Purpose Gets the time from the NonStop.

PAGE 70

Class Gateway Java Import Package Reference Side Effects Sets the values of ScobolLib.terminationStatus, ScobolLib.transactionId, and ScobolLib.restartCounter. Method beginTransaction (for ON ERROR clause) Purpose Initiates a transaction on the NonStop on behalf of this client. Syntax public void beginTransaction (String onTxnErrorMethod, Object param) throws ScobolTxnException Description Equivalent to the ON ERROR clause associated with the SCREEN COBOL BEGINTRANSACTION statement.

PAGE 71

Class Gateway Java Import Package Reference Description Equivalent to the SCREEN COBOL DIALOG-ABORT statement. The Exception class, ScobolSendException, is defined in the pathway.its package. Side Effects Sets the values of ScobolLib.terminationStatus, ScobolLib.terminationSubStatus, and ScobolLib.dialogInfo. Method dialogBegin Purpose Performs a server-class dialog begin operation to the specified server class.

PAGE 72

Class Gateway Java Import Package Reference pathmonName Identifies the Pathmon process for which the server class is configured. If this value is not specified, the value is NULL. This parameter is optional; if the server class is monitored by the same Pathmon process as the gateway terminal, then this parameter is not necessary. If the server class is remote, you must specify the name of the server class Pathmon process. systemName Identifies the system on which the Pathmon process is running.

PAGE 73

Class Gateway Java Import Package Reference Method dialogSend Purpose Continues to perform the send operation to a server class identified by a previously initiated dialogBegin () call. Syntax Public void dialogSend (ScobolType() sendItems, ServerReplyCode replyMap) throws ScobolTxnException, ScobolSendException Description Equivalent to the SCREEN COBOL DIALOG-SEND statement. Note that ScobolType and ServerReplyCode data types are already defined in pathway.its package.

PAGE 74

Class Gateway Java Import Package Reference Method send Purpose Performs a server-class send operation to the specified server class. Syntax public void send (ScobolType[] sendItems, String serverclassName, String pathmonName, String systemName, ServerReplyCode replyMap) throws ScobolTxnException, ScobolSendException Description Equivalent to the SCREEN COBOL SEND statement.

PAGE 75

Class ServerReplyCode Java Import Package Reference Class ServerReplyCode The ServerReplyCode class allows the user to specify the server reply code in a SCREEN COBOL SEND statement. The ServerReplyCode object is a required parameter in the Gateway.send method. Package pathway.its Syntax public pathway.its.ServerReplyCode Description This class contains methods that allow the user to specify a server reply code.

PAGE 76

Class ServerReplyCode Java Import Package Reference Description Equivalent to the REPLY CODE reply-code-value YIELDS identifier-2 clause of the SCREEN COBOL SEND statement. This method is called once for each reply-code-value in the YIELDS clause. Parameters replyCode Equivalent to reply-code-value in the YIELDS clause of the SEND statement. If null, this is the same as REPLY CODE OTHER. terminationStatus The value to which ScobolLib.

PAGE 77

HTML Screen Interaction Classes Java Import Package Reference Parameters replyCode Equivalent to reply-code-value in the YIELDS clause of the SEND statement. If null, this is the same as REPLY CODE OTHER. terminationStatus The value to which ScobolLib.terminationStatus is to be set when the server’s reply code matches the value of replyCode. identifier An array of identifier values; equivalent to identifier-2 in the YIELDS clause. Side Effects Sets the value of ScobolLib.terminationStatus.

PAGE 78

Class ScreenField Java Import Package Reference Package pathway.its Syntax public pathway.its.ScreenField implements ScreenFieldIdentifier Description This class provides methods to set the various attributes associated with a screen field.

PAGE 79

Class ScreenField Java Import Package Reference Methods setADVISORY() Equivalent to the ADVISORY field-characteristic clause setCONTROLLEDBY() Equivalent to the CONTROLLED [BY] fieldcharacteristic clause setCONVERTBLANKS() Equivalent to the CONVERT BLANKS fieldcharacteristic clause setFILL() Equivalent to the FILL field-characteristic clause setInitAttribute() Sets the initial attributes of a screen field setLENGTH() Equivalent to the LENGTH [MUST BE] fieldcharacteristic clause setMUSTBE() Eq

PAGE 80

Java Import Package Reference Class ScreenField Parameters name The value of the name attribute of the HTML control element. For example, for , name = new String ("WS-ITEM1"). from Corresponds to the data item in the FROM clause in the SCREEN COBOL field description. This parameter can be null. to Corresponds to the data item in the TO clause in the SCREEN COBOL field description. This parameter can be null.

PAGE 81

Java Import Package Reference Class ScreenField Parameters controlObject Corresponds to data-name-1 in the CONTROLLED [BY] clause Method setCONVERTBLANKS Syntax public void setCONVERTBLANKS() Description Equivalent to the CONVERT BLANKS field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string USER [CONVERSION] numeric-literal CONVERT BLANKS Method setFILL Syntax public void setFILL (char fillChar) Description Equivalent to the FILL field-characteris

PAGE 82

Java Import Package Reference Class ScreenField Description This method sets the initial attributes of a screen field. For example, the SCREEN COBOL data description entry screen-field-name [AT] line-spec, column-spec PIC [IS] character-string PROTECTED, MDTON has this Java equivalent: screenfieldObject.setInitAttribute (ScreenField.ATTR_PROTECTED | ScreenField.

PAGE 83

Java Import Package Reference Class ScreenField Parameters lengthArray Corresponds to the literal-n values in the LENGTH [MUST BE] clause. The array must be of the form {minLen1,maxLen1,minLen2, maxLen2,...}. Each maxLenx must be >= minLenx. If a value is to be discrete rather than a range, then set minLenx and maxLenx to the same discrete value. Method setMUSTBE Syntax public void setMUSTBE (String[] valueMustBe) Description Equivalent to the MUST [BE] field-characteristic clause.

PAGE 84

Class ScreenField Java Import Package Reference Parameters shadowByte Corresponds to data-name-1 in the SHADOWED [BY] clause isReturnBitAlwaysSet Must be TRUE if the modified data tag (MDT) for the screen field is set to ON; otherwise, must be FALSE Method setUPSHIFT Syntax public void setUPSHIFT (int i) Description Equivalent to the UPSHIFT field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string UPSHIFT { INPUT | OUTPUT | INPUT-OUTPUT } Parameter

PAGE 85

Java Import Package Reference Class ScreenField Parameters userCode Corresponds to the routine number (numeric-literal) in the USER [CONVERSION] clause. contextObject A user-defined object returned by calling screenFieldObject.getcontextObject(). This parameter can be null.

PAGE 86

Java Import Package Reference Class ScreenFieldArray Description Equivalent to the WHEN BLANK field-characteristic clause, as in: screen-field-name [AT] line-spec, column-spec PIC [IS] character-string USING data-name-1 WHEN BLANK { CLEAR | SKIP } Parameters whenBlank Must be either CLEAR or SKIP Class ScreenFieldArray The ScreenFieldArray class is the Java representation of the OCCURS clause for screen fields. Package pathway.its Syntax public pathway.its.

PAGE 87

Class ScreenFieldArray Java Import Package Reference Member Summary Data Members public public public public public public public public public static static static static static static static static static final final final final final final final final final int int int int int int int int int ATTR_BELL ATTR_BLINK ATTR_DEFAULT ATTR_HIDDEN ATTR_MDTON ATTR_OUTLINE ATTR_PROTECTED ATTR_RVIDEO ATTR_UNDERLINE public static final int CLEAR public static final int SKIP public static final int UPSHIFT_INPUT

PAGE 88

Class ScreenFieldArray Java Import Package Reference Methods addField() Adds a screen field to the array setADVISORY() Equivalent to the ADVISORY field-characteristic clause setCONTROLLEDBY() Equivalent to the CONTROLLED [BY] fieldcharacteristic clause setCONVERTBLANKS() Equivalent to the CONVERT BLANKS fieldcharacteristic clause setFILL() Equivalent to the FILL field-characteristic clause setInitAttribute() Sets the initial attributes of the screen fields setLENGTH() Equivalent to the LENGTH

PAGE 89

Java Import Package Reference Class ScreenFieldArray Parameters maxOccurs The value of columns-literal* lines-literal in the fieldcharacteristic clause OCCURS IN columns-literal COLUMNS ON lines-literal LINES. dependingOn Corresponds to data-name-1 in the field-characteristic clause OCCURS IN columns-literal COLUMNS ON lines-literal LINES DEPENDING [ON] data-name-1. This parameter can be null.

PAGE 90

Java Import Package Reference Class ScreenFieldArray Parameters controlObject Corresponds to data-name-1 in the CONTROLLED [BY] clause Method setCONVERTBLANKS Syntax public void setCONVERTBLANKS() Description Equivalent to the CONVERT BLANKS field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES USER [CONVERSION] numeric-literal CONVERT BLANKS Method setFILL Syntax public void setFILL (char fillChar) Description Equivalent to the FILL field-characteristic clause,

PAGE 91

Java Import Package Reference Class ScreenFieldArray has this Java equivalent: screenfieldArrayObject.setInitAttribute (ScreenFieldArray.ATTR_PROTECTED | ScreenFieldArray.ATTR_MDTON) Parameters attribute Represents the initial screen-field attributes to be set at run time, constructed by bitwise ORing of the attribute literals to be set Method setLENGTH Syntax public void setLENGTH (int[] lengthArray) Description Equivalent to the LENGTH [MUST BE] field-characteristic clause.

PAGE 92

Class ScreenFieldArray Java Import Package Reference Description Equivalent to the MUST [BE] field-characteristic clause. For example, the SCREEN COBOL clause OCCURS IN columns-literal COLUMNS ON lines-literal LINES MUST BE 10 THRU 20, HELLO has this Java equivalent: String[] valueMustBe = {"10","20","HELLO","HELLO"}; screenfieldArrayObject.setMUSTBE (valueMustBe); Parameters valueMustBe Corresponds to the literal-n values in the MUST [BE] clause.

PAGE 93

Java Import Package Reference Class ScreenFieldArray Description Equivalent to the UPSHIFT field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES UPSHIFT { INPUT | OUTPUT | INPUT-OUTPUT } Parameters Must be ScreenFieldArray.UPSHIFT_INPUT, ScreenFieldArray.UPSHIFT_OUTPUT, or ScreenFieldArray.

PAGE 94

Java Import Package Reference Class ScreenFieldGroup Method setWhenAbsent Syntax public void setWhenAbsent (int whenAbsent) Description Equivalent to the WHEN ABSENT field-characteristic clause, as in: OCCURS IN columns-literal COLUMNS ON lines-literal LINES USING data-name-1 WHEN ABSENT { CLEAR | SKIP } Parameters whenAbsent Must be either CLEAR or SKIP Method setWhenBlank Syntax public void setWhenBlank (int whenBlank) Description Equivalent to the WHEN BLANK field-characteristic clause, as in: OCC

PAGE 95

Class ScreenFieldGroup Java Import Package Reference Description This class implements the equivalent of a SCREEN COBOL screen group. It is essentially a container for all the screen field objects that are part of a screen group.

PAGE 96

Java Import Package Reference Class HTMLHandler Description Adds a screen field array to this object. Parameters A previously instantiated ScreenFieldArray object (that is, a screen field associated with an OCCURS clause) that is part of this ScreenFieldGroup object field Class HTMLHandler The HTMLHandler class encapsulates the SCREEN COBOL statements associated with displaying and accepting SCREEN COBOL screens. Examples of such statements are DISPLAY BASE, DISPLAY, and ACCEPT. Package pathway.

PAGE 97

Class HTMLHandler Java Import Package Reference UI Interaction Methods accept() Equivalent to the SCREEN COBOL ACCEPT statement clearInput() Equivalent to the SCREEN COBOL CLEAR INPUT statement display() Equivalent to the SCREEN COBOL DISPLAY statement displayBase() Equivalent to the SCREEN COBOL DISPLAY BASE statement displayOverlay() Equivalent to the SCREEN COBOL DISPLAY OVERLAY statement displayOverlaySpaces() Equivalent to the SCREEN COBOL DISPLAY OVERLAY SPACES AT statement resetAttribut

PAGE 98

Class HTMLHandler Java Import Package Reference Syntax public void accept (ScreenFieldIdentifier[] fieldIds, FunctionKey[] untilFuncKeys, FunctionKey[] escFuncKeys public void accept (ScreenFieldIdentifier[] fieldIds, FunctionKey[] untilFuncKeys, FunctionKey[] escFuncKeys, int timeout, int timeoutTerminationStatus) Description The first form of the syntax is equivalent to the SCREEN COBOL statement: ACCEPT {screen-identifier}...

PAGE 99

Java Import Package Reference Class HTMLHandler Method clearInput Purpose Clears the HTML field values. Syntax public void clearInput() Description Equivalent to the SCREEN COBOL CLEAR INPUT statement. Method display Purpose Displays the corresponding HTML field values for ScreenField objects.

PAGE 100

Class HTMLHandler Java Import Package Reference Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the DISPLAY statement isTemporary If true, corresponds to the presence (and if false, to the absence) of the TEMP clause of the DISPLAY statement literal If non-null, corresponds to the presence (and if null, to the absence) of the IN clause of the DISPLAY statement dependingOn If non-null, corresponds to the presence (and if null, to the absence) of the DEP

PAGE 101

Class HTMLHandler Java Import Package Reference Parameters htmlFilename The name of the HTML file to be displayed; for example, page.html. It is assumed that this HTML file is in the same directory as the HTML file containing the applet (cframe.html in the example). formName The value of the NAME attribute in the
tag present in the page.html document. frameName The value of the NAME attribute in the tag present in the frameset.html document.

PAGE 102

Class HTMLHandler Java Import Package Reference Description This method is equivalent to the SCREEN COBOL statement DISPLAY OVERLAY overlay-area-name. It must be called before calling display(). This method does not display an HTML page; the actual display is done during the call to display(). Parameters overlayScreenName The name of the HTML file that contains the overlay screen to be displayed overlayArea The name of the Overlay Area on the screen.

PAGE 103

Java Import Package Reference Class HTMLHandler Method resetAttribute Purpose Resets the HTML field attributes for a selected number of fields.

PAGE 104

Class HTMLHandler Java Import Package Reference Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the RESET ATTR statement isTemporary If true, corresponds to the presence (and if false, to the absence) of the TEMP clause of the RESET ATTR statement dependingOn If non-null, corresponds to the presence (and if null, to the absence) of the DEPENDING [ON] clause of the RESET ATTR statement isShadowed If true, corresponds to the presence (and if false, to th

PAGE 105

Class HTMLHandler Java Import Package Reference Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the RESET DATA statement isTemporary If true, corresponds to the presence (and if false, to the absence) of the TEMP clause of the RESET DATA statement dependingOn If non-null, corresponds to the presence (and if null, to the absence) of the DEPENDING [ON] clause of the RESET DATA statement isShadowed If true, corresponds to the presence (and if false, to th

PAGE 106

Class HTMLHandler Java Import Package Reference Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the SET NEW-CURSOR statement dependingOn If non-null, corresponds to the presence (and if null, to the absence) of the DEPENDING [ON] clause of the SET NEW-CURSOR statement isShadowed If true, corresponds to the presence (and if false, to the absence) of the SHADOWED clause of the SET NEWCURSOR statement Method turn Purpose Changes the display attributes of a

PAGE 107

Class FunctionKey Java Import Package Reference Parameters fieldIDs An array of ScreenIdentifier objects; corresponds to screen-identifiers in the TURN statement isTemporary If true, corresponds to the presence (and if false, to the absence) of the TEMP clause of the TURN statement attrFlag If 0, implies the DYNAMIC clause of the TURN statement; otherwise, the value is the ORed combination of attributes from the DisplayAttribute class dependingOn If non-null, corresponds to the presence (and if nul

PAGE 108

Data-Type Classes Java Import Package Reference Description Constructor for the FunctionKey class. Parameters keyLabel The literal that appears in the function-key dropdown box on the HTML page terminationStatusValue The value to which ScobolLib.

PAGE 109

Class ScobolType Java Import Package Reference Abstract Methods getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array Non-Abstract Methods isEqualTo() Equivalent to the SCREEN COBOL relation condition IS [NOT] EQUAL [TO] isEqualToAll() Equivalent to the SCREEN COBOL relation condition IS

PAGE 110

Java Import Package Reference Class ScobolType Return Value Returns the number of bytes required to represent the data item in the NonStop Kernel. Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public abstract byte [] getHostValue() Description The NonStop Kernel defines the data representation (bit pattern) for representing variables of a given type.

PAGE 111

Java Import Package Reference Class ScobolType Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] noninteger-numeric-literal. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise.

PAGE 112

Java Import Package Reference Class ScobolType Method isEqualTo (String data) Syntax public boolean isEqualTo (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] string-literal. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise.

PAGE 113

Java Import Package Reference Class ScobolType Method isGreaterThan (double data) Syntax public boolean isGreaterThan (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] noninteger-numeric-literal. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise.

PAGE 114

Java Import Package Reference Class ScobolType Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (String data) Syntax public boolean isGreaterThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] string-literal.

PAGE 115

Java Import Package Reference Class ScobolType Method isLessThan (double data) Syntax public boolean isLessThan (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] noninteger-numeric-literal. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise.

PAGE 116

Java Import Package Reference Class ScobolType Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (String data) Syntax public boolean isLessThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] string-literal.

PAGE 117

Class ScobolGroupType Java Import Package Reference Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise. Class ScobolGroupType Package pathway.its Syntax public abstract pathway.its.ScobolGroupType extends ScobolType Description This abstract class is the super-class for all SCREEN COBOL group data types implemented in Java.

PAGE 118

Class ScobolGroupType Java Import Package Reference Non-Abstract Methods isValueAlphabetic() Equivalent to the SCREEN COBOL class condition IS [NOT] ALPHABETIC isValueNumeric() Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC moveAll() Equivalent to the SCREEN COBOL MOVE ALL statement setHighValues() Equivalent to the SCREEN COBOL MOVE HIGHVALUES statement setLowValues() Equivalent to the SCREEN COBOL MOVE LOWVALUES statement setQuotes() Equivalent to the SCREEN COBOL MOVE QUOTES

PAGE 119

Class ScobolGroupType Java Import Package Reference Parameters ScobolDataObject An object of type ScobolType in the group that that is being added. Example This is an example SCREEN COBOL group data item: 01 CURRENT-TIME. 05 TIME-AT-START 05 DATE-AT-START 05 TIME-NOW PIC 9(8). PIC 9(8). PIC 9(8).

PAGE 120

Java Import Package Reference Class ScobolGroupType Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public abstract byte [] getHostValue() Description The NonStop Kernel defines the data representation (bit pattern) for representing variables of a given type. The getHostValue() method returns the identical bit pattern, independent of its internal storage representation.

PAGE 121

Java Import Package Reference Class ScobolGroupType Return Value Returns TRUE if the value of this object is [not] alphabetic, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise.

PAGE 122

Java Import Package Reference Class ScobolGroupType Description Equivalent to the SCREEN COBOL statement MOVE LOW-VALUES TO group-item. Method setQuotes Syntax public void setQuotes() Description Equivalent to the SCREEN COBOL statement MOVE QUOTES TO group-item. Method setSpaces Syntax public void setSpaces() Description Equivalent to the SCREEN COBOL statement MOVE SPACES TO group-item.

PAGE 123

Java Import Package Reference Class ScobolGroupType Parameters The data used to set the value of this object data Method setValue (ScobolType data) Syntax public void setValue (ScobolType data) Description Equivalent to the SCREEN COBOL statement MOVE data-name-1 TO group-2, where data-name-1 is the parameter to this method and group-2 is this object.

PAGE 124

Class Pic9 Java Import Package Reference Class Pic9 Package pathway.its Syntax public pathway.its.Pic9 extends ScobolType Description This class is the Java representation of the SCREEN COBOL numeric integer (both computational and display) data types. SCREEN COBOL numeric integer data types are those that are described by the PIC 9 clauses.

PAGE 125

Class Pic9 Java Import Package Reference Class-Specific Methods getValue() Returns the value in native Java type isEqualTo() Equivalent to the SCREEN COBOL relation condition IS [NOT] EQUAL [TO] isGreaterThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] GREATER [THAN] isLessThan() Equivalent to the SCREEN COBOL relation condition IS [NOT] LESS [THAN] isValueNumeric() Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC setValue() Equivalent to the SCREEN COBOL stateme

PAGE 126

Class Pic9 Java Import Package Reference Parameters numDigits The number of digits in the integer; must be between 1 and 18, inclusive computational Must be either Pic9.COMP or Pic9.DISPLAY signed Must be either Pic9.SIGNED or Pic9.UNSIGNED Method Constructor (Sign Leading or Trailing) Syntax public Pic9 (int numDigits, int signFlag) Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC S9(n) sign lead new Pic9 (n, Pic9.

PAGE 127

Java Import Package Reference Class Pic9 Return Value Returns the number of bytes required to represent the equivalent SCREEN COBOL data item in the NonStop Kernel. Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public byte [] getHostValue() Description The byte array does not necessarily represent an actual numeric item. Any arbitrary byte pattern can be stored in this object with the setHostValue() method.

PAGE 128

Java Import Package Reference Class Pic9 Parameters The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). data Method getValue Syntax public long getValue() Description If the object is non-computational, the byte contents must be ASCII 0 through ASCII 9 (except for the sign byte). Return Value Returns the numeric value stored in the object.

PAGE 129

Java Import Package Reference Class Pic9 Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (ScobolType data) Syntax public boolean isEqualTo (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] ws-item-2, where ws-item-1 is a PIC 9 identifier.

PAGE 130

Java Import Package Reference Class Pic9 Method isGreaterThan (double data) Syntax public boolean isGreaterThan (double data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] noninteger-numeric-literal, where ws-item-1 is a PIC 9 identifier. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise.

PAGE 131

Java Import Package Reference Class Pic9 Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] ws-item-2, where ws-item-1 is a PIC 9 identifier. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise.

PAGE 132

Java Import Package Reference Class Pic9 Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isLessThan (long data) Syntax public boolean isLessThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] integer-numeric-literal, where ws-item-1 is a PIC 9 identifier.

PAGE 133

Java Import Package Reference Class Pic9 Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] string-literal, where ws-item-1 is a PIC 9 identifier. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC.

PAGE 134

Java Import Package Reference Class Pic9 Description Equivalent to the SCREEN COBOL statement MOVE integer-numeric-literal TO ws-item, where ws-item is a PIC 9 identifier. Parameters The data used to set the value of this object data Method setValue (Pic9 data) Syntax public void setValue (Pic9 data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-itemdest, where both ws-item-src and ws-item-dest are PIC 9 identifiers.

PAGE 135

Java Import Package Reference Class Pic9 Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-itemdest, where ws-item-src is a PIC 9V identifier and ws-item-dest is a PIC 9 identifier. Parameters The data used to set the value of this object data Method setValue (PicX data) Syntax public void setValue (PicX data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-itemdest, where ws-item-src is a PIC X identifier and ws-item-dest is a PIC 9 identifier.

PAGE 136

Java Import Package Reference Class Pic9P Description Equivalent to the SCREEN COBOL statement MOVE string-numeric-literal TO ws-item, where ws-item is a PIC 9 identifier. Parameters The data used to set the value of this object data Method setZeroes Syntax public void setZeroes() Description Equivalent to the SCREEN COBOL statement MOVE ZEROS TO data-name-1, where data-name-1 is this object. Class Pic9P Package pathway.its Syntax public pathway.its.

PAGE 137

Class Pic9P Java Import Package Reference Abstract Method Implementation getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array Class-Specific Methods getValue() Returns the value in native Java type isEqualTo() Equivalent to the SCREEN COBOL relation condition IS [NOT] EQUAL [TO] isGreat

PAGE 138

Class Pic9P Java Import Package Reference Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC 9(m)P(n) COMP new Pic9P (m, n, Pic9P.COMP, Pic9P.UNSIGNED) PIC S9(m)P(n) COMP new Pic9P (m, n, Pic9P.COMP, Pic9P.SIGNED) PIC 9(m)P(n) new Pic9P (m, n, Pic9P.DISPLAY, Pic9P.UNSIGNED) PIC S9(m)P(n) new Pic9P (m, n, Pic9P.DISPLAY, Pic9P.SIGNED) PIC P(n)9(m) COMP new Pic9P (m, -(m+n), Pic9P.COMP, Pic9P.

PAGE 139

Class Pic9P Java Import Package Reference Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC S9(m)P(n) sign lead new Pic9P (m, n, Pic9P.SIGNLEADING) PIC S9(m)P(n) sign trail new Pic9P (m, n, Pic9P.SIGNTRAILING) PIC S9(m)P(n) sign lead separate new Pic9P (m, n, Pic9P.SIGNLEADINGSEPARATE) PIC S9(m)P(n) sign trail separate new Pic9P (m, n, Pic9P.SIGNTRAILINGSEPARATE) PIC SP(n)9(m) sign lead new Pic9P (m, -(m+n), Pic9P.

PAGE 140

Java Import Package Reference Class Pic9P Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public byte [] getHostValue() Description The byte array does not necessarily represent an actual numeric item. Any arbitrary byte pattern can be stored in this object with the setHostValue() method.

PAGE 141

Java Import Package Reference Class Pic9P Parameters The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). data Method getValue Syntax public double getValue() Description If the object is non-computational, the byte contents must be ASCII 0 through ASCII 9 (except for the sign byte). Return Value Returns the numeric value stored in the object.

PAGE 142

Java Import Package Reference Class Pic9P Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (ScobolType data) Syntax public boolean isEqualTo (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] ws-item-2, where ws-item-1 is a PIC 9P identifier.

PAGE 143

Java Import Package Reference Class Pic9P Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] noninteger-numeric-literal, where ws-item-1 is a PIC 9P identifier. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise.

PAGE 144

Java Import Package Reference Class Pic9P Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (String data) Syntax public boolean isGreaterThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] string-literal, where ws-item-1 is a PIC 9P identifier.

PAGE 145

Java Import Package Reference Class Pic9P Method isLessThan (long data) Syntax public boolean isLessThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] integer-numeric-literal, where ws-item-1 is a PIC 9P identifier. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise.

PAGE 146

Java Import Package Reference Class Pic9P Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise.

PAGE 147

Java Import Package Reference Class Pic9P Parameters The data used to set the value of this object data Method setValue (Pic9P data) Syntax public void setValue (Pic9P data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-itemdest, where both ws-item-src and ws-item-dest are PIC 9P identifiers.

PAGE 148

Java Import Package Reference Class Pic9V Parameters The data used to set the value of this object data Method setValue (String data) Syntax public void setValue (String data) Description Equivalent to the SCREEN COBOL statement MOVE string-literal TO ws-item, where ws-item is a PIC 9P identifier.

PAGE 149

Class Pic9V Java Import Package Reference Member Summary Constructor Pic9V() Abstract Method Implementation getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array Class-Specific Methods getValue() Returns the value in native Java type isEqualTo() Equivalent to the SCREEN COBOL relation co

PAGE 150

Class Pic9V Java Import Package Reference Method Constructor (Signed or Unsigned) Syntax public Pic9V (int numIntegerDigits, int numFractionDigits, boolean computational, boolean signed) Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC 9(m)V9(n) COMP new Pic9V (m, n, Pic9V.COMP, Pic9V.UNSIGNED) PIC S9(m)V9(n) COMP new Pic9V (m, n, Pic9V.COMP, Pic9V.SIGNED) PIC 9(m)V9(n) new Pic9V (m, n, Pic9V.DISPLAY, Pic9V.

PAGE 151

Class Pic9V Java Import Package Reference Description This form is used to construct these SCREEN COBOL types: SCREEN COBOL Type Java Type PIC S9(m)V9(n) sign lead new Pic9V (m, n, Pic9V.SIGNLEADING) PIC S9(m)V9(n) sign trail new Pic9V (m, n, Pic9V.SIGNTRAILING) PIC S9(m)V9(n) sign lead separate new Pic9V (m, n, Pic9V.SIGNLEADINGSEPARATE) PIC S9(m)V9(n) sign trail separate new Pic9V (m, n, Pic9V.

PAGE 152

Java Import Package Reference Class Pic9V Method getHostValue Purpose Returns the NonStop Kernel representation of the data as a byte array. Syntax public byte [] getHostValue() Description The byte array does not necessarily represent an actual numeric item. Any arbitrary byte pattern can be stored in this object with the setHostValue() method.

PAGE 153

Java Import Package Reference Class Pic9V Parameters The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). data Method getValue Syntax public double getValue() Description If the object is non-computational, the byte contents must be ASCII 0 through ASCII 9 (except for the sign byte). Return Value Returns the numeric value stored in the object.

PAGE 154

Java Import Package Reference Class Pic9V Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] equal to data, or FALSE otherwise. Method isEqualTo (ScobolType data) Syntax public boolean isEqualTo (ScobolType data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] EQUAL [TO] ws-item-2, where ws-item-1 is a PIC 9V identifier.

PAGE 155

Java Import Package Reference Class Pic9V Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] noninteger-numeric-literal, where ws-item-1 is a PIC 9V identifier. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise.

PAGE 156

Java Import Package Reference Class Pic9V Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] greater than data, or FALSE otherwise. Method isGreaterThan (String data) Syntax public boolean isGreaterThan (String data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] GREATER [THAN] string-literal, where ws-item-1 is a PIC 9V identifier.

PAGE 157

Java Import Package Reference Class Pic9V Method isLessThan (long data) Syntax public boolean isLessThan (long data) Description Equivalent to the SCREEN COBOL relation condition ws-item-1 IS [NOT] LESS [THAN] integer-numeric-literal, where ws-item-1 is a PIC 9V identifier. Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise.

PAGE 158

Java Import Package Reference Class Pic9V Parameters The value to be compared with the value of this object data Return Value Returns TRUE if the value of this object is [not] less than data, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC. Return Value Returns TRUE if the value of this object is [not] numeric, or FALSE otherwise.

PAGE 159

Java Import Package Reference Class Pic9V Parameters The data used to set the value of this object data Method setValue (Pic9P data) Syntax public void setValue (Pic9P data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-itemdest, where ws-item-src is a PIC 9P identifier and ws-item-dest is a PIC 9V identifier.

PAGE 160

Java Import Package Reference Class Pic9V Parameters The data used to set the value of this object data Method setValue (ScobolGroupType data) Syntax public void setValue (ScobolGroupType data) Description Equivalent to the SCREEN COBOL statement MOVE ws-group-item TO ws-item-dest, where ws-group-item is a group item identifier and ws-item-dest is a PIC 9V identifier.

PAGE 161

Class PicN Java Import Package Reference Class PicN Package pathway.its Syntax public pathway.its.PicN extends ScobolType Description This class is the Java representation of the SCREEN COBOL double-byte data types; that is, those that are described by the PIC N clause.

PAGE 162

Class PicN Java Import Package Reference Class-Specific Methods getValue() Returns the value in native Java type isDoubleByte() Equivalent to the SCREEN COBOL clause IS [NOT] DOUBLEBYTE in the IF ...

PAGE 163

Class PicN Java Import Package Reference Method Constructor (Justification Specified) Syntax public PicN (int size, boolean justification) Description Upon construction, the object will contain blanks. Parameters size The number of double-byte characters this object can hold justification Must be either PicN.LEFTJUSTIFIED or PicN.RIGHTJUSTIFIED Method Constructor (Initialized Data, Left-Justified) Syntax public PicN (int size, String data) Description In this form, data is left justified.

PAGE 164

Class PicN Java Import Package Reference Parameters size The number of double-byte characters this object can hold justification Must be either PicN.LEFTJUSTIFIED or PicN.RIGHTJUSTIFIED data The initial value for this object Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data.

PAGE 165

Java Import Package Reference Class PicN Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public void setHostValue (byte[] data) Description This method is used to store a byte pattern in this object. Parameters The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). data Method getValue Syntax public String getValue() Return Value Returns the object as a Java string.

PAGE 166

Java Import Package Reference Class PicN Method moveAll Syntax public void moveAll (String str) Description Equivalent to the SCREEN COBOL statement MOVE ALL string-literal TO ws-item, where ws-item is a PIC N identifier. Parameters The string literal to be moved into this object str Method setSpaces Syntax public void setSpaces() Description Equivalent to the SCREEN COBOL statement MOVE SPACES TO ws-item, where ws-item is a PIC N identifier.

PAGE 167

Java Import Package Reference Class PicX Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-itemdest, where ws-item-src is a PIC X identifier and ws-item-dest is a PIC N identifier. The PIC X identifier can contain a combination of double-byte and singlebyte characters.

PAGE 168

Class PicX Java Import Package Reference Syntax public pathway.its.PicX extends ScobolType Description This class is the Java representation of the SCREEN COBOL alphanumeric data types; that is, those that are described by the PIC X clause.

PAGE 169

Class PicX Java Import Package Reference Class-Specific Methods getValue() Returns the value in native Java type isDoubleByte() Equivalent to the SCREEN COBOL clause IS [NOT] DOUBLEBYTE in the IF ...

PAGE 170

Class PicX Java Import Package Reference Parameters The number of characters this object can hold size Method Constructor (Justification Specified) Syntax public PicX (int size, boolean justification) Description Upon construction, the object will contain blanks. Parameters size The number of characters this object can hold justification Must be either PicX.LEFTJUSTIFIED or PicX.

PAGE 171

Class PicX Java Import Package Reference than the specified size, the data will be truncated in accordance with SCREEN COBOL rules. Parameters size The number of characters this object can hold justification Must be either PicX.LEFTJUSTIFIED or PicX.RIGHTJUSTIFIED data The initial value for this object Method getHostLength Purpose Returns the number of bytes required to store the NonStop Kernel representation of the data.

PAGE 172

Java Import Package Reference Class PicX Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public void setHostValue (byte[] data) Description This method is used to store a byte pattern in this object. Parameters The byte array whose contents will be the new value of this object. The length of the array must be greater than or equal to getHostLength(). data Method getValue Syntax public String getValue() Return Value Returns the object as a Java string.

PAGE 173

Java Import Package Reference Class PicX Method isValueAlphabetic Syntax public boolean isValueAlphabetic() Description Equivalent to the SCREEN COBOL class condition IS [NOT] ALPHABETIC. Return Value Returns TRUE if the value of this object is [not] alphabetic, or FALSE otherwise. Method isValueNumeric Syntax public boolean isValueNumeric() Description Equivalent to the SCREEN COBOL class condition IS [NOT] NUMERIC.

PAGE 174

Java Import Package Reference Class PicX Description Equivalent to the SCREEN COBOL statement MOVE HIGH-VALUES TO ws-item, where ws-item is a PIC X identifier. Method setLowValues Syntax public void setLowValues() Description Equivalent to the SCREEN COBOL statement MOVE LOW-VALUES TO ws-item, where ws-item is a PIC X identifier. Method setQuotes Syntax public void setQuotes() Description Equivalent to the SCREEN COBOL statement MOVE QUOTES TO ws-item, where ws-item is a PIC X identifier.

PAGE 175

Java Import Package Reference Class PicX Parameters The data used to set the value of this object data Method setValue (long data) Syntax public void setValue (long data) Description Equivalent to the SCREEN COBOL statement MOVE integer-literal TO ws-item, where ws-item is a PIC X identifier.

PAGE 176

Java Import Package Reference Class PicX Parameters The data used to set the value of this object data Method setValue (Pic9V data) Syntax public void setValue (Pic9V data) Description Equivalent to the SCREEN COBOL statement MOVE ws-item-src TO ws-itemdest, where ws-item-src is a PIC 9V identifier and ws-item-dest is a PIC X identifier.

PAGE 177

Java Import Package Reference Transform Class Parameters The data used to set the value of this object data Method setValue (String data) Syntax public void setValue (String data) Description Equivalent to the SCREEN COBOL statement MOVE string-literal TO ws-item, where ws-item is a PIC X identifier.

PAGE 178

Class Transform Java Import Package Reference Member Summary Constructor Transform() Methods doTransform() Implements the TRANSFORM statement yields() Equivalent to the YIELDS clause of the TRANSFORM statement Method Constructor (no select code field) Syntax public Transform (ScobolType[] inRec) Description This form instantiates an object to implement a TRANSFORM statement without the SELECT CODE FIELD [IS] clause.

PAGE 179

Class Transform Java Import Package Reference Parameters inRec An array of ScobolType objects, each of which corresponds to a working-storage item specified in trans-rec-out in the TRANSFORM statement selectCode The ScobolType object corresponding to the working-storage item specified in the SELECT CODE FIELD [IS] clause in the TRANSFORM statement offset Indicates the position of the selectCode value within trans-rec-out in the TRANSFORM statement Method doTransform Syntax public void doTransform()

PAGE 180

Class Transform Java Import Package Reference Description This form is equivalent to this clause of the SCREEN COBOL TRANSFORM statement: [SELECT CODE FIELD [IS] code-field] CODE select-code YIELDS trans-rec-in where the select-code value is specified as an integer depending on the business logic. This form instantiates a Pic9 object as the code-field. This method is called once for each select-code value in the YIELDS clause.

PAGE 181

ProgramUnit Class Java Import Package Reference Description This form is equivalent to this clause of the SCREEN COBOL TRANSFORM statement: [SELECT CODE FIELD [IS] code-field] CODE select-code YIELDS trans-rec-in where the select-code value is specified as a working-storage item. This form instantiates a ScobolType object as the code-field. This method is called once for each select-code value in the YIELDS clause.

PAGE 182

Class ProgramUnit Java Import Package Reference Member Summary Data Members public static final char COMMA Represents the character ',' public PicX diagnosticAllowed Equivalent to the DIAGNOSTIC-ALLOWED special register public static final char PERIOD Represents the character '.

PAGE 183

Class ProgramUnit Java Import Package Reference Method getNewOverlayManager Syntax public OverlayManager getNewOverlayManager (String baseHTMLFileName) Description Obtains a handle to an OverlayManager object that is local to this program unit. Parameters baseHTMLFileName The file name of the HTML page that corresponds to the base screen Return Value Returns a handle to an object of type OverlayManager. Method setCurrencySign Purpose Sets the character to be used as the currency symbol.

PAGE 184

Java Import Package Reference Special-Register Classes Description Equivalent to the DECIMAL-POINT IS clause in the SPECIAL-NAMES paragraph of a SCREEN COBOL program. Parameters decimalChar The character that is to represent the decimal point Method stopRun Syntax public void [] stopRun() throws StopRunException Description Equivalent to the SCREEN COBOL statement STOP RUN.

PAGE 185

Class ScobolLib Java Import Package Reference Member Summary Data Members public static final int ASCII public public public public public public public public public public public public public public public public public public public public public public public public public dialogInfo KANJI_KATAKANA logicalTerminalName newCursor OldCursor pwQueueFkeyTimeout pwQueueFkeyUmp pwTCPProcessName pwTCPSystemName pwTerminalErrorOccurred pwUnsolicitedMessageQueued pwUseNewCursor redisplay restartCounter stop

PAGE 186

Class ScobolLib Java Import Package Reference Description Equivalent to the SCREEN COBOL DELAY statement. Parameters The value to delay, in seconds delayTime Method setCharSet Purpose Specifies the character set. Syntax public static void setCharSet (int charSetValue) Description Equivalent to the SCREEN COBOL CHARACTER-SET IS statement in the OBJECTCOMPUTER paragraph of the Environment Division.

PAGE 187

Class Cursor Java Import Package Reference Parameters operand1 The first operand in the intermediate operation of exponentiation. operand2 The second operand; an integer. Class Cursor Package pathway.its Syntax public pathway.its.Cursor extends ScobolType Description This abstract class is the Java representation of the SCREEN COBOL special registers NEW-CURSOR and OLD-CURSOR.

PAGE 188

Class Cursor Java Import Package Reference Abstract Method Implementation getHostLength() Returns the number of bytes required to store the NonStop Kernel representation of the data getHostValue() Returns the NonStop Kernel representation of the data as a byte array setHostValue() Updates the value of the object with the given byte array Class-Specific Methods initialize() Equivalent to the SCREEN COBOL statement MOVE ZEROS to NEW-CURSOR or MOVE ZEROS TO OLD-CURSOR Method Constructor Syntax public

PAGE 189

Java Import Package Reference Class Cursor Description The length of the returned byte array will be the same as that returned by getHostLength(). Return Value Returns the byte array used to represent the numeric value in the NonStop Kernel. Method setHostValue Purpose Updates the value of the object with the given byte array. Syntax public void setHostValue (byte[] data) Description This method is used to store a byte pattern in this object.

PAGE 190

Java Import Package Reference Exception Classes Exception Classes The exception classes provide handling for the Java equivalents of SCREEN COBOL exceptions. Class ExitProgramException Package pathway.its Syntax public pathway.its.ExitProgramException extends RunTimeException Description This class represents the exception that is thrown when an error is encountered during processing of an EXIT PROGRAM statement.

PAGE 191

Class ScobolSendException Java Import Package Reference Member Summary Constructor ScobolException() Method Constructor (int argument) Syntax public ScobolException (int errorNum) Description A string corresponding to the error number is passed to the parent class (RuntimeException) and is then available through a call to toString().

PAGE 192

Class ScobolTxnException Java Import Package Reference Member Summary Constructor ScobolSendException() Method Constructor (int argument) Syntax public ScobolSendException (int errorNum) Description A string corresponding to the error number is passed to the parent class (Exception) and is then available through a call to toString().

PAGE 193

Java Import Package Reference Class StopRunException Member Summary Constructor ScobolTxnException() Method Constructor Syntax public ScobolTxnException() Class StopRunException Package pathway.its Syntax public pathway.its.StopRunException extends RunTimeException Description This class represents the exception that is thrown when an error is encountered during processing of a STOP RUN statement.

PAGE 194

Java Import Package Reference Class TransformException Description This class represents the exception that is thrown when an error is encountered during processing of a TRANSFORM statement.

PAGE 195

User Conversion Classes Java Import Package Reference User Conversion Classes The user conversion classes define the Java equivalent of the standard user conversion routines in PATHTCPL. Class UserConversion Package pathway.its Syntax public interface pathway.its.UserConversion Description This interface class is used by the ScLibUserConversion class.

PAGE 196

Class ScLibUserConversion Java Import Package Reference Parameters fldArray An array of ScreenField objects for which user conversion is to be done; corresponds to screen fields having the USER CONVERSION clause in SCREEN COBOL Description This method is automatically invoked during execution of the accept() method. It is called before the data is moved from the screen fields to the associated TO objects.

PAGE 197

Class ScLibUserConversion Java Import Package Reference Member Summary Constructor ScLibUserConversion() Methods doInputUserConversion() Implementation of the standard screen input user conversion routines doOutputUserConversion() Implementation of the standard screen output user conversion routines getServerClassName() Returns the name of the server class that performs the user conversion Method Constructor Syntax public ScLibUserConversion (String serverClass, Gateway gateway) Description Constr

PAGE 198

Class ScLibUserConversion Java Import Package Reference Parameters fldArray An array of ScreenField objects for which user conversion is to be done; corresponds to screen fields having the USER CONVERSION clause in SCREEN COBOL Description This method is automatically invoked during execution of the accept() method. It is called before the data is moved from the screen fields to the associated TO objects.

PAGE 199

7 Introduction to Pathway/iTS 1.1 Pathway/iTS 1.1 provides large message (more than 32,000 bytes) communication support between SCOBOL requesters (and converted Java clients) and Pathway servers. Today, support for large message communication is available to TS/MP Pathsend requesters in the form of context-sensitive APIs (SERVERCLASS_DIALOG_* APIs). Pathway/iTS 1.1 intends to support large message communication by introducing a new TCP process called PATHTCP4. The new TCP component of Pathway/iTS 1.

PAGE 200

Architecture of Pathway/iTS 1.1 Introduction to Pathway/iTS 1.1 Architecture of Pathway/iTS 1.1 Figure 7-1. Architecture of Pathway/iTS 1.1 NonStop TS/MP Environment SERVER CLASS Server Processes COMMAND TERM Application Database PATHCOM PATHMON $zlnn TERM (Temporary, from RUN Program) APPLICATION TERM PATHTCP4 Screen Program TERM (Configured) WEB CLIENT Router Pathway/iTS 1.1 Environment VST003.

PAGE 201

Introduction to Pathway/iTS 1.1 SCOBOL Verbs and Special Register Pathway/iTS 1.1 contains two TCP components, PATHTCP4 and the legacy TCP component PATHTCP3. PATHTCP4 serves the same Java clients and the SCREEN COBOL applications but with a different architecture. It does not perform the link management activities and therefore does not communicate with the target PATHMON process directly.

PAGE 202

Introduction to Pathway/iTS 1.1 Web Clients in Pathway/iTS 1.1 its reply. It ends the dialog by returning the file-system error 0 (FEOK). The server replies with the file-system error 70 (FECONTINUE) to continue with the dialog. The requester calls DIALOG-ABORT to abort the dialog. The requester calls DIALOG-END to clean up resources after the server has ended or aborted the dialog. Only one active dialog per requester terminal is allowed at any given time.

PAGE 203

Introduction to Pathway/iTS 1.1 Special Registers SEND is outstanding, the backup TCP, after takeover, aborts the current transaction and restarts interpretation of SCOBOL code from the BEGINTRANSACTION statement. • • • If a SEND verb is being performed under NO transaction (BEGIN-TRANSACTION is not performed before executing the SEND statement), PATHTCP4 always performs checkpoint before and after SEND statement.

PAGE 204

Introduction to Pathway/iTS 1.1 FREEZE SERVER Command Changes register) and prohibits the link managers (LINKMON processes) from sending requests to a server class. If a server process has incomplete requests or is in active dialog, the PATHMON process cannot freeze the server class until these requests are completed. While waiting for the requests to complete, the server class goes into a FREEZEPENDING state.

PAGE 205

Introduction to Pathway/iTS 1.1 Statistics Collected by Pathway/iTS 1.1 Statistics Collected by Pathway/iTS 1.1 In PATHTCP4, the statistics collected are different from PATHTCP3. PATHTCP4 does not generate statistics for SERVER objects. TS/MP ROUT processes generate SERVER object statistics. For details on how the TS/MP ROUT processes generate SERVER object statistics, see the TS/MP System Management Manual, or TS/MP Supplement for Limits Relief Manual depending on the ROUT process running on your system.

PAGE 206

Introduction to Pathway/iTS 1.1 Error Handling in Pathway/iTS 1.1 the SCOBOL program provided the ON ERROR clause is specified. The processing of SCOBOL program continues in this case depending on the error handling logic of the program. If the ON ERROR clause is not specified, the backup TCP after take over aborts the terminal. In most cases, this requires an operator intervention to correct the situation.

PAGE 207

A Client Error Messages This appendix describes the pop-up messages that end users can receive while running a Pathway/iTS web client. General Information Messages with numbers in the range 3000 through 3299 are analogous to the corresponding, same-numbered terminal control process (TCP) messages issued when screen programs are running on the NonStop system. These messages are generated by the Pathway/iTS gateway threads and passed to the Java applet portion of the web client.

PAGE 208

Client Error Messages Message Descriptions 3003 *3003* INVALID SUBSCRIPT VALUE error-loc Cause. The value of a subscript expression was either zero or larger than the limit implied by the OCCURS clause. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application.

PAGE 209

Client Error Messages Message Descriptions 3007 *3007* SCREEN OPERATION DONE WITHOUT BASE DISPLAYED error-loc Cause. A screen-manipulation operation was attempted before a DISPLAY BASE statement was executed. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application.

PAGE 210

Client Error Messages Message Descriptions 3020 *3020* CALLED PROGRAM UNIT NOT FOUND error-loc Cause. The program unit specified in a CALL statement was not found in the TCLPROG files. Effect. The operation fails. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3022 *3022* SEND: SERVER CLASS NAME INVALID error-loc Cause.

PAGE 211

Client Error Messages Message Descriptions present in the Java code—then the ON ERROR branch is taken. Otherwise, the applet stops. Recovery. Either configure TMF auditing or isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3031 *3031* TMF NOT RUNNING error-loc Cause.

PAGE 212

Client Error Messages Message Descriptions 3049 *3049* EXIT PROGRAM ENCOUNTERED error-loc Cause. The applet stopped because it encountered an exit through an EXIT PROGRAM statement in the highest-level (main) program unit. Effect. The applet stops. Recovery. Informational message only; no corrective action is needed. 3052 *3052* TERMINAL STOPPED BY PROGRAM error-loc Cause. The applet stopped because it encountered an exit through a STOP RUN statement in the highest-level (main) program unit. Effect.

PAGE 213

Client Error Messages Message Descriptions 3072 *3072* RUN-TIME DYNAMIC ATTRIBUTE SETTING INVALID error-loc Cause. An invalid attribute setting was detected, or the specified attribute setting would cause an out-of-bounds condition to occur during the run-time processing of the control structure. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem.

PAGE 214

Client Error Messages Message Descriptions Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3113 *3113* TRANSACTION MESSAGE SIZE EXCEEDS LIMIT error-loc Cause. The size of a message for a SEND operation to a server exceeded that allowed by the SERVERPOOL attribute in the terminal control process (TCP) configuration. Effect.

PAGE 215

Client Error Messages Message Descriptions 3116 *3116* ERROR DURING SERVER I/O (errnum) error-loc Cause. The file-system error errnum occurred during an I/O operation to a server process. Effect. The I/O operation fails. The terminal control process (TCP) unlinks from the server class. Recovery. See the Guardian Procedure Errors and Messages Manual for information regarding the specified file-system error. 3117 *3117* object-name SERVER CLASS UNDEFINED error-loc Cause.

PAGE 216

Client Error Messages Message Descriptions 3119 *3119* NO SPACE FOR NEW SERVER PROCESS error-loc Cause. The terminal control process (TCP) attempted to link with more server processes than were defined for the MAXSERVERPROCESSES attribute. Effect. The operation fails. Recovery. Redefine the MAXSERVERPROCESSES attribute and restart the application. 3164 *3164* CODE OF RECEIVED MESSAGE UNDEFINED error-loc Cause.

PAGE 217

Client Error Messages Message Descriptions Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, remove the unsupported function from the SCREEN COBOL program and reconvert the application. 3203 *3203* FUNCTION UNIMPLEMENTED error-loc Cause. The SCREEN COBOL program included a function that is not supported for conversion. Effect. The applet stops. Recovery.

PAGE 218

Client Error Messages Message Descriptions Recovery. Isolate the server class within the SCREEN COBOL program and make sure the server class is in STARTED mode before applying SEND/DIALOG to it. For instructions on how to isolate the server class within the program, see Additional Error Information on page 13-1 in the Pathway/iTS System Management Manual. 3247 *3247* A NON-RETRYABLE LINKMON CONNECT ERROR OCCURED (errnum) Note.

PAGE 219

Client Error Messages Message Descriptions the SCREEN COBOL program. If ON ERROR clause is not mentioned, TCP suspends the terminal after logging the error against the term; however, the term can be resumed to restart processing at the last verb. Recovery. If the associated file-system error is 100 then it means that the LINKMON process is just started on the CPU and is not yet ready to accept the Pathsend requests. The term must retry the operation after a time delay.

PAGE 220

Client Error Messages • • • • Message Descriptions A second DIALOG-BEGIN was attempted when the term is already under active dialog. A DIALOG-SEND was attempted without the term being under active dialog. A DIALOG-END was attempted without the term being under active dialog. A DIALOG-ABORT was attempted without the term being under active dialog. Effect. The operation fails.

PAGE 221

Client Error Messages Message Descriptions Effect. The operation fails. If ON ERROR clause is mentioned, then error is reported against the term but the term continues to run depending on the error-handling logic in the SCREEN COBOL program. If ON ERROR clause is not mentioned, then TCP aborts the terminal after logging the error against the term. Recovery. Clean up the requester portion of dialog by calling DIALOG-END and initiate a new dialog if required.

PAGE 222

Client Error Messages Message Descriptions 3301 *3301* TRANSACTION ERROR error-loc Cause. A transaction error occurred on the NonStop system—for example, a unilateral abort of a transaction. Effect. If the ON ERROR clause of the BEGIN-TRANSACTION statement is present in the SCREEN COBOL source code—that is, if the onTxnErrorMethod method is present in the Java code—then the ON ERROR branch is taken. Otherwise, the applet stops. Recovery.

PAGE 223

Client Error Messages Message Descriptions 3304 *3304* INVALID PARAMETER error-loc Cause. An invalid parameter value was passed. Effect. The applet stops. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3305 *3305* UNKNOWN HOST error-loc Cause. The program attempted to communicate with a host NonStop system that was unknown.

PAGE 224

Client Error Messages Message Descriptions Recovery. Check the Pathway log file for any error message related to failure in the start of a transaction. Isolate and correct the problem within the Java program, using the Pathway log file and the stack trace information in error-loc to locate the problem. Alternatively, correct the problem in the SCREEN COBOL program and reconvert the application. 3308 *3308* SPECIFIED URL FORMAT IS INVALID Cause.

PAGE 225

Client Error Messages Message Descriptions 3312 *3312* CHARACTER-SET SHOULD BE KANJI-KATAKANA Cause. The CHARACTER-SET IS clause of SCREEN COBOL upon conversion specifies character set other than KANJI-KATAKANA or ASCII. Note that special character set values is not required for European language character-sets as Java takes care of them. Effect. The operation fails. Recovery. Isolate and correct the problem within the Java program, using the stack trace information in error-loc to locate the problem.

PAGE 226

Client Error Messages Message Descriptions HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 A-20

PAGE 227

B SCREEN COBOL Features Not Supported for Web Conversion Certain SCREEN COBOL features are either not supported for conversion to web clients or have a modified representation in the converted code. In some cases, this is because the features are not applicable in a web environment or because of limitations imposed by Java. Table B-1 lists the SCREEN COBOL statements and clauses that are not supported or have limited support for conversion.

PAGE 228

SCREEN COBOL Features Not Supported for Web Conversion Table B-1. Web Conversion Support Limitations (page 1 of 4) Recommended Corrective Action SCREEN COBOL Feature Converter Action CHECKPOINT Because the web client does not run with a backup process, this statement is not meaningful in a web environment. The converter generates a warning and continues converting the rest of the program. The converted Java code contains the warning statement as a comment.

PAGE 229

SCREEN COBOL Features Not Supported for Web Conversion Table B-1. Web Conversion Support Limitations (page 2 of 4) Recommended Corrective Action SCREEN COBOL Feature Converter Action PIC9V data items with more than 16-digit precision The precision of the converted code is limited to the most significant 16 digits after the decimal point. The converter generates an error and continues converting the remaining program units. The converted Java code contains a non-compilable error message.

PAGE 230

SCREEN COBOL Features Not Supported for Web Conversion Table B-1. Web Conversion Support Limitations (page 3 of 4) Recommended Corrective Action SCREEN COBOL Feature Converter Action RESTART-TRANSACTION The converter generates an error and continues converting the rest of the program. The converted Java code contains a non-compilable statement. Either remove the noncompilable statement from the converted code or remove the RESTARTTRANSACTION statement from the SCREEN COBOL source program.

PAGE 231

SCREEN COBOL Features Not Supported for Web Conversion Table B-1. Web Conversion Support Limitations (page 4 of 4) Recommended Corrective Action SCREEN COBOL Feature Converter Action TERMINALINFO The converter generates an error and continues converting the rest of the program. The converted Java code contains a non-compilable statement. Evaluate the use of the TERMINALINFO statement and modify the converted code or the SCREEN COBOL source program accordingly.

PAGE 232

SCREEN COBOL Features Not Supported for Web Conversion HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 B- 6

PAGE 233

Index A abortTransaction method 6-4 ABORT-TRANSACTION statement, Java implementation of 6-4 abstract class for actions applying to program units 6-117 for NEW-CURSOR and OLD-CURSOR special registers 6-123 for SCREEN COBOL data types 6-44 for SCREEN COBOL group data types 6-53 ACCEPT DATE statement, Java implementation of 6-4 ACCEPT DAY statement, Java implementation of 6-4 accept method 6-33 ACCEPT statement, Java implementation of 5-6, 6-33 ACCEPT TIME statement, Java implementation of 6-5 acceptDate metho

PAGE 234

Index D compiling a converted application OSS environment 2-8 Windows environment 2-9 computational data types, Java implementation of integer 6-60 noninteger 6-72, 6-84 real 6-84 configuration file, for converting SCREEN COBOL programs 2-2 configuring Pathway applications with web clients 1-1 user conversion server class 4-2 user profile server class 3-6 Connection not established with gateway… (message 3300) A-15 constructor for Cursor class 6-124 for ExitProgramException class 6-126 for FunctionKey cla

PAGE 235

Index E database for user profiles 3-2 data-type classes 6-44 decimal point character, setting 6-119 delay method 6-121 delaying program execution 6-121 DEPENDING variable value too big (message 3002) A-1 deploying web clients OSS environment 2-9 Windows environment 2-11 developing web clients diagram 1-2/1-3 steps in process 2-1/2-17 DEVICEINFO statement, not supported B-2 DIALOG-ABORT statement, Java implementation of 6-6 DIALOG-BEGIN statement, Java implementation of 6-7 DIALOG-END statement, Java impl

PAGE 236

Index F exceptions (continued) for transaction errors 6-128 for TRANSFORM statement 6-129 for unrecoverable terminal errors 6-126 eXecute method 5-5 Exit program encountered (message 3049) A-6 EXIT PROGRAM statement, Java implementation of 6-118 EXIT RECOVERY statement, not supported B-2 exitProgram method 6-118 ExitProgramException class constructor 6-126 details 6-126 Expect display usage (message 3310) A-18 F Fatal error during BEGIN TRANSACTION (message 3307) A-17 Fault Tolerance Pathway/iTS 1.

PAGE 237

Index I HTML pages control page 5-3 initial page 5-2 mapping of Screen section to 5-3, 5-7 starting page 5-2 HTML screen interaction classes 6-13 HTMLHandler class constructor 6-33 details 6-32 methods 6-33 use of by converter 5-5 HTMLVOL parameter, in CONVERT command 5-7 HTTP protocol, support for 1-4 I Illegal ACCEPT variable timeout value (message 3037) A-5 Illegal delay value (message 3074) A-7 import package See Java import package for web clients initial attributes of screen field, setting 6-17, 6-

PAGE 238

Index J S [NOT] NUMERIC condition, Java implementation of (continued) for PIC X data types 6-109 generic 6-53 isDoubleByte method in PicN class 6-101 in PicX class 6-108 isEqualTo method in Pic9 class 6-64 in Pic9P class 6-77 in Pic9V class 6-89 in ScobolType class 6-46 isEqualToAll method 6-48 isGreaterThan method in Pic9 class 6-66 in Pic9P class 6-78 in Pic9V class 6-90 in ScobolType class 6-49 isGreaterThanAll method 6-50 isLessThan method in Pic9 class 6-67 in Pic9P class 6-80 in Pic9V class 6-92 in

PAGE 239

Index M LOGICAL-TERMINAL-NAME special register 3-2 logon security 3-1 M main applet, Java 5-2 maintaining code for web clients 1-1, 2-16 make file, for building converted application 2-8 managing Pathway applications with web clients 1-1 Maximum reply size exceeds limit (message 3114) A-8 MDT, not used by web clients 5-6, B-2 Message Section, not supported B-5 methods extra, to perform special tasks 5-5 in Cursor class 6-124 in Gateway class 6-3 in HTMLHandler class 6-33 in Pic9 class 6-60 in Pic9P class

PAGE 240

Index N N names of Java objects for Working-Storage data items 5-4 of methods for SCREEN COBOL paragraphs 5-5 of nested Java classes for group-level items 5-3 of ScreenField objects for SCREEN COBOL input-output objects 5-6 of user HTML pages 5-7 NEW-CURSOR special register, Java implementation of 6-123 nld utility 4-2 No room for new server class in TCP (message 3110) A-7 No space for new server process (message 3119) A-10 noninteger numeric data types, Java implementation of 6-72, 6-84 NonStop™ Himalaya

PAGE 241

Index Q Pic9P class (continued) constructor 6-73 details 6-72 literals 6-73 methods 6-73 constructor 6-86 data precision limit B-3 details 6-84 literals 6-85 methods 6-85 PicN class constructor 6-98 details 6-97 literals 6-98 methods 6-97 PicX class constructor 6-105 details 6-103 literals 6-105 methods 6-104 port number, setting for router process 2-13 PRINT SCREEN statement, not supported B-3 PROFDBM utility 2-4, 3-5 profiles, user See user profiles program units, mapping to Java classes 5-3 ProgramUnit

PAGE 242

Index S S ScLibUserConversion class constructor 6-133 details 6-132 methods 6-133 SCOBOL 7-3 SCOBOL Verbs and Special Register 7-3 ScobolException class constructor 6-127 details 6-126 ScobolGroupType class constructor 6-54 details 6-53 methods 6-53 ScobolLib class data members 6-121 details 6-120 methods 6-121 ScobolSendException class constructor 6-128 details 6-127 ScobolTxnException class constructor 6-129 details 6-128 ScobolType class constructor 6-45 data members 6-44 details 6-44 methods 6-45 SCRE

PAGE 243

Index S Send: server class name invalid (message 3022) A-4 server class for user conversion routines, configuring 4-2 for user profiles, configuring 3-6 Server class name invalid (message 3022) A-4 Server class undefined (message 3117) A-9 ServerReplyCode class constructor 6-11 details 6-11 methods 6-11 server-class send operation, Java implementation of 6-10 sessionlength parameter in control.

PAGE 244

Index T setVALUE method (continued) in ScreenFieldArray class 6-29 setValue method in Pic9 class 6-69 in Pic9P class 6-82 in Pic9V class 6-94 in PicN class 6-102 in PicX class 6-110 in ScobolGroupType class 6-58 setWhenAbsent method in ScreenField class 6-21 in ScreenFieldArray class 6-30 setWhenBlank method in ScreenField class 6-21 in ScreenFieldArray class 6-30 setZeroes method in Pic9 class 6-72 in Pic9P class 6-84 in Pic9V class 6-96 in PicX class 6-113 in ScobolGroupType class 6-59 SHADOWED [BY] cla

PAGE 245

Index U U Unix operating system building web clients on 2-8 specifying as build environment 2-2 Unknown host (message 3305) A-17 Unsolicited-message processing, not supported B-3 UPSHIFT clause, Java implementation of 6-20, 6-28 USE FOR SCREEN-RECOVERY statement, not supported B-5 USE FOR TERMINAL-ERRORS statement, not supported B-5 user conversion routines building library for 4-2 configuring server class for 2-14, 4-2 getting server-class name for 6-134 Java classes for 6-131 setting up for use with web

PAGE 246

Index Y WHEN BLANK clause, Java implementation of 6-21, 6-30 Windows NT operating system building web clients on 2-9 specifying as build environment 2-2 Working-Storage section, mapping to Java classes 5-3 Y YIELDS clause of TRANSFORM statement, Java implementation of 6-115 yields method 6-115 HP NonStop Pathway/iTS Web Client Programming Manual—520270-003 Index-14

PAGE 247

Content Feedback First Name: __________________ Phone: _____________________ Company: ___________________ Last Name: _________________ e-mail address: ______________ (All contact information fields are required.) If you’re reporting an error or omission, is your issue: Minor: I can continue to work, but eventual resolution is requested. Major: I can continue to work, but prompt resolution is requested. Critical: I cannot continue to work without immediate response.

Who We Are

About Us

Company

Careers

Terms & Privacy

Resources

List of Manufacturers

Support

For the Press

Media assets

FAQ

Get in touch

Blog

Email

DMCA

ManualShelf © 2013-2025