com.ibm.ims.application
Class IMSApplication

java.lang.Object
  |
  +--com.ibm.ims.application.IMSApplication

public abstract class IMSApplication
extends java.lang.Object

IMSApplication is the abstract base class for all Java Dependent Region programs. A Java Dependent Region application must subclass IMSApplication implement a main method and override its doBegin method. The main method must instantiate the subclassed IMSApplication class and call its begin method. Control is returns to the application in its implementation of the deBegin method. Java Dependent Region applications should implement their entire application from within their overrided doBegin method. The begin method does application setup, invokes its abstract doBegin method, and upon its return, terminates the application.


Constructor Summary
protected IMSApplication()
          Creates a new IMSAppication object
 
Method Summary
 void begin()
          The begin method first sets up the Java Dependent Region environment before invoking its abstract doBegin method, returning control to the application.
abstract  void doBegin()
          All Java Dependent Region applications must override this method and define their own application here.
 java.lang.String programName()
          Returns the application's program name from the IMSInfo call to IMS.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IMSApplication

protected IMSApplication()
Creates a new IMSAppication object
Method Detail

begin

public final void begin()
The begin method first sets up the Java Dependent Region environment before invoking its abstract doBegin method, returning control to the application. Upon the return of doBegin it terminates the application, and resets the environment.

doBegin

public abstract void doBegin()
                      throws java.lang.Exception
All Java Dependent Region applications must override this method and define their own application here.
Throws:
java.lang.Exception - The application may throw exceptions that will be caught by the begin method and rethrown as a RuntimeException bringing down the Region.

programName

public java.lang.String programName()
                             throws IMSException
Returns the application's program name from the IMSInfo call to IMS.
Returns:
The application's program name
Throws:
IMSException - if a non-blank status code is returned from the system call


(C) International Business Machines Corporation 2004. All rights reserved.