com.ibm.as400.opnav
Class OpNavApplication

java.lang.Object
  |
  +--com.ibm.as400.opnav.OpNavApplication

public class OpNavApplication
extends java.lang.Object

The invocation class for IBM admin console applications. Each instance of OpNavApplication is constructed using configuration information specified in the Java registry. The console window for the application may then be displayed by calling one of the invoke() methods.

Since:
v5r1m0

Constructor Summary
OpNavApplication()
           
OpNavApplication(java.lang.String appName)
          Constructs an OpNavApplication instance for the specified console application.
OpNavApplication(java.lang.String appName, java.lang.String systemName)
          Constructs an OpNavApplication instance for the specified console application.
OpNavApplication(java.lang.String appName, java.lang.String systemName, java.lang.String windowName)
          Constructs an OpNavApplication instance for the specified console application.
OpNavApplication(java.lang.String appName, java.lang.String systemName, java.lang.String windowName, java.lang.String frameManager)
          Used to create an application with no registry
 
Method Summary
 void addFrame(javax.swing.tree.TreePath path, com.ibm.as400.opnav.OpNavFrame frame)
           
 com.ibm.as400.opnav.OpNavFrame cloneFrame(int windowType, java.lang.String rootType)
           
 void disposeWindows()
           
 com.ibm.as400.opnav.OpNavFrame getFrame()
           
 com.ibm.as400.opnav.OpNavFrame getFrame(javax.swing.tree.TreePath path, java.lang.String type)
           
 boolean invoke()
          Displays the main console window for this application.
 boolean invokeAndWait()
          Displays the main console window for this application.
 void Main(java.lang.String[] args)
           
 void removeFrame(javax.swing.tree.TreePath path)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OpNavApplication

public OpNavApplication()

OpNavApplication

public OpNavApplication(java.lang.String appName)
                 throws OpNavConsoleException
Constructs an OpNavApplication instance for the specified console application.

Parameters:
appName - Name of the admin console application as specified in the Java registry.
Throws:
OpNavConsoleException - If the configuration information in the Java registry was specified incorrectly, or an I/O error was encountered attempting to access the registry.
Since:
v5r1m0

OpNavApplication

public OpNavApplication(java.lang.String appName,
                        java.lang.String systemName)
                 throws OpNavConsoleException
Constructs an OpNavApplication instance for the specified console application.

Parameters:
appName - Name of the admin console application as specified in the Java registry.
systemName - Name of the AS/400 system to be displayed at the root of the console hierarchy.
Throws:
OpNavConsoleException - If the configuration information in the Java registry was specified incorrectly, or an I/O error was encountered attempting to access the registry.
Since:
v5r1m0

OpNavApplication

public OpNavApplication(java.lang.String appName,
                        java.lang.String systemName,
                        java.lang.String windowName,
                        java.lang.String frameManager)
                 throws OpNavConsoleException
Used to create an application with no registry

OpNavApplication

public OpNavApplication(java.lang.String appName,
                        java.lang.String systemName,
                        java.lang.String windowName)
                 throws OpNavConsoleException
Constructs an OpNavApplication instance for the specified console application.

Parameters:
appName - Name of the admin console application as specified in the Java registry.
systemName - Name of the AS/400 system to be displayed at the root of the console hierarchy.
windowName - Name of the secondary window to be launched if this is not the application's main window.
Throws:
OpNavConsoleException - If the configuration information in the Java registry was specified incorrectly, or an I/O error was encountered attempting to access the registry.
Since:
v5r1m0
Method Detail

invoke

public boolean invoke()
               throws OpNavConsoleException
Displays the main console window for this application. Control returns immediately to the calling program.

Returns:
true if the console window was successfully displayed; false if another instance of this application already exists and SINGLE was specified for the application's Instance attribute in the registry.
Since:
v5r1m0
See Also:
invokeAndWait()

invokeAndWait

public boolean invokeAndWait()
                      throws OpNavConsoleException
Displays the main console window for this application. The calling program's execution is suspended until the console window closes.

Returns:
true if the console window was successfully displayed; false if another instance of this application already exists and SINGLE was specified for the application's Instance attribute in the registry. The calling program's execution does not block if invokeAndWait returns false.
Since:
v5r1m0
See Also:
invoke()

Main

public void Main(java.lang.String[] args)
          throws com.ibm.as400.ui.framework.java.DisplayManagerException,
                 java.lang.IllegalArgumentException,
                 NodeNotFoundException,
                 RegistryException

getFrame

public com.ibm.as400.opnav.OpNavFrame getFrame()

getFrame

public com.ibm.as400.opnav.OpNavFrame getFrame(javax.swing.tree.TreePath path,
                                               java.lang.String type)

addFrame

public void addFrame(javax.swing.tree.TreePath path,
                     com.ibm.as400.opnav.OpNavFrame frame)

removeFrame

public void removeFrame(javax.swing.tree.TreePath path)

disposeWindows

public void disposeWindows()

cloneFrame

public com.ibm.as400.opnav.OpNavFrame cloneFrame(int windowType,
                                                 java.lang.String rootType)
                                          throws com.ibm.as400.ui.framework.java.DisplayManagerException,
                                                 RegistryException,
                                                 NodeNotFoundException