com.ibm.as400.opnav
Class UIServices

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

public class UIServices
extends java.lang.Object

Implements a suite of platform-dependent User Interface services. UIServices is re-implemented on each UI platform so that Operations Navigator components needn't concern themselves with the details of how to update a status area or refresh a list of objects.

Since:
v4r4m0

Field Summary
static int LIST_ITEM
          THIS METHOD IS CURRENTLY NOT SUPPORTED Selection target.
static int TREE_ITEM
          THIS METHOD IS CURRENTLY NOT SUPPORTED Selection target.
 
Constructor Summary
UIServices()
          Construct the UIServices object.
 
Method Summary
 void addContextMenuHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String ContextMenuHandler)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ContextMenuHandler with a node type
 void addContextMenuHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String ContextMenuHandler, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ContextMenuHandler with a node type
 void addDropHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String DropHandler)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a DropHandler with a node type
 void addDropHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String DropHandler, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a DropHandler with a node type
 void addHelpSet(java.awt.Frame owner, java.lang.String objType, java.lang.String helpSet, java.lang.String helpID)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskInformationManager with a node type
 void addHelpSet(java.awt.Frame owner, java.lang.String objType, java.lang.String helpSet, java.lang.String helpID, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskInformationManager with a node type
 void addListHeadingManager(java.awt.Frame owner, java.lang.String objType, java.lang.String ListHeadingManager, java.lang.String WhenCalled)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ListHeadingManager with a node type
 void addListHeadingManager(java.awt.Frame owner, java.lang.String objType, java.lang.String ListHeadingManager, java.lang.String WhenCalled, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ListHeadingManager with a node type
 void addListManager(java.awt.Frame owner, java.lang.String objType, java.lang.String listManager)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ListManager with a node type
 void addListManager(java.awt.Frame owner, java.lang.String objType, java.lang.String listManager, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ListManager with a node type
 void addMenubarActionHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String MenubarActionHandler)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a MenubarActionHandler with a node type
 void addMenubarActionHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String MenubarActionHandler, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a MenubarActionHandler with a node type
 void addPropertySheetHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String PropertySheetHandler)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a PropertySheetHandler with a node type
 void addPropertySheetHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String PropertySheetHandler, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a PropertySheetHandler with a node type
 void addTaskInformationManager(java.awt.Frame owner, java.lang.String objType, java.lang.String taskInfoMgr)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskInformationManager with a node type
 void addTaskInformationManager(java.awt.Frame owner, java.lang.String objType, java.lang.String taskInfoMgr, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskInformationManager with a node type
 void addTaskPadHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String taskPadHandler, java.lang.String whenCalled, java.lang.String[] cascadingVerbs)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskPadHandler with a node type
 void addTaskPadHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String taskPadHandler, java.lang.String whenCalled, java.lang.String[] cascadingVerbs, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskPadHandler with a node type
 void addToolbarButtonHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String ToolbarButtonHandler)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ToolbarButtonHandler with a node type
 void addToolbarButtonHandler(java.awt.Frame owner, java.lang.String objType, java.lang.String ToolbarButtonHandler, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ToolbarButtonHandler with a node type
 void addTreeHeadingManager(java.awt.Frame owner, java.lang.String objType, java.lang.String TreeHeadingManager, java.lang.String WhenCalled)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TreeHeadingManager with a node type
 void addTreeHeadingManager(java.awt.Frame owner, java.lang.String objType, java.lang.String TreeHeadingManager, java.lang.String WhenCalled, boolean childrenAffected)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TreeHeadingManager with a node type
 boolean checkAS400Name(java.lang.String AS400Name, java.lang.String systemName, int typeID)
          Check the AS400 name
 boolean checkObjectAuthority(java.lang.String objectPath, java.lang.String objectType, java.lang.String authorityType, java.lang.String systemName)
          Returns an indication of whether the Operations Navigator user has authority to a particular object on the AS/400.
 boolean checkSpecialAuthority(java.lang.String specialAuthority, java.lang.String systemName)
          Returns an indication of whether the Operations Navigator user has a particular special authority on the AS/400.
 boolean closeWindow(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Closes the window
 void collapsePath(java.awt.Frame owner, ObjectName objectName)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Collpases the path refered to by the ObjectName
static void DebugOutput(java.lang.String outstring)
           
 void displayProperties(java.awt.Frame owner, ObjectName objectName)
          Displays the system properties dialog for the specified object.
 void displayProperties2(java.awt.Frame owner, ObjectName objectName)
           
 boolean displaySOAJob(java.lang.String systemName, java.lang.String targetSystem, java.lang.String jobName, int jobType, boolean queuedJobs, boolean activeJobs, boolean completedJobs, java.lang.String[] jobQueue, int[] sortColumn, int[] disallowActions, boolean disallowFilter, boolean allJobs, java.lang.String[] currentUser, java.lang.String[] primaryStatus, boolean showErrorMessage)
          Display an SOA Job
 boolean displaySOAJobLog(java.lang.String systemName, java.lang.String targetSystem, java.lang.String jobName, boolean showErrorMessage)
          Display an SOA Job Log
 boolean displaySOAList(java.lang.String systemName, java.lang.String command, boolean showErrorMessage)
          Deprecated. in V5R1, replaced by displaySOA specific functions.
 boolean displaySOAMessage(java.lang.String systemName, java.lang.String targetSystem, int severity, java.lang.String userName, int[] disallowActions, boolean disallowFilter, boolean showErrorMessage)
          Display an SOA Message
 boolean displaySOAPrinter(java.lang.String systemName, java.lang.String targetSystem, java.lang.String[] printerName, int[] disallowActions, boolean disallowFilter, boolean showErrorMessage)
          Display an SOA Printer
 boolean displaySOASpooledFile(java.lang.String systemName, java.lang.String targetSystem, java.lang.String[] userProfileName, java.lang.String[] outQueue, java.lang.String formType, java.lang.String userData, java.lang.String[] status, java.lang.String[] printerName, java.lang.String jobName, int[] sortColumn, int[] disallowActions, boolean disallowFilter, boolean showErrorMessage)
          Display an SOA Spooled File
 void expandPath(java.awt.Frame owner, ObjectName objectName)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Expands the path refered to by the ObjectName
 int getAdminCacheState(java.lang.String systemName)
          Returns the admin cache state on the specified system.
 int getAdminValue(java.lang.String systemName, java.lang.String adminFunction)
          Returns the admin value for the specified admin function on the specified system.
 ObjectName getCachedObjectName(java.lang.String componentType, java.lang.String objectType, java.lang.String parentType, java.lang.String displayName, java.lang.String parentName, java.lang.String systemName)
          Searches the cache of active ListManagers for an ObjectName that matches the input parameters.
 java.lang.String getCentralSystemName()
          Returns the system name of the current central system.
 java.lang.String getCurrentLanguageName()
          Returns the descriptive name of the current language setting.
 int[] getDisplayedColumns(java.awt.Frame owner, ObjectName objectName)
          THIS METHOD IS CURRENTLY NOT SUPPORTED lisadier 7-14-2000 This method returns the column ids of the currently displayed columns for the give type.
 java.lang.String getFileSystemName(ObjectName objectName)
          Returns the file system name of the object, provided the object resides in the file system.
 java.awt.Image getFrameIcon(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Gets the current frame icon
 java.lang.String getFrameTitle(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Gets the title of the frame
 int getHostAdminValue(java.lang.String systemName, java.lang.String adminFunction)
          Returns the admin value for the specified 'Host' category admin function on the specified system.
 java.lang.String getLanguageName(java.lang.String featureCode)
          Returns the descriptive name of the language setting.
 boolean getSecureConnection(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the state of the secure connection icon in lower left of the Operations Navigator frame window.
 ObjectName[] getSelectedObjects(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED This method will a list of items that are currently selected in the console
 int getSelectedWindow(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED This method will return window that has the current focus, and selection
 java.lang.String[] getSystemList()
          Retrieve the persistent list of AS/400 systems configured on the installed client.
 java.lang.String getSystemValue(int value, java.lang.String systemName)
          Returns a string containing the value of an AS/400 system value.
 boolean getTaskPadPaneVisible(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Checks to see if the Task Pad Pane is visible in the frame
 boolean getTreePaneVisible(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Checks to see if the Tree Pane is visible in the frame
 java.lang.String getUserAttribute(int attributeId, java.lang.String systemName)
          Returns a string containing the value of a user profile attribute for the current Operations Navigator user.
 int getVersion()
          Returns the version of the com.ibm.as400.opnav package.
 boolean isComponentInstalled(int option)
          Determines if a specified Operations Navigator component is installed.
 boolean isConnected(java.lang.String systemName)
          Determine if there is connection to the specified system
 boolean isConnected(java.lang.String systemName, java.lang.String appName)
          Determine if there is connection to the specified system
 boolean isConnectionTypeTCPIP(java.lang.String systemName)
          Determine if the system connection is using TCP/IP for communications
 boolean isExpanded(java.awt.Frame owner, ObjectName objectName)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Checks if the node refered to by the ObjectName is expanded
 boolean isExploreFromHereVisible(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the visiblity status of the explore from here context menu action
 boolean isExploreVisible(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the visiblity status of the explore context menu action
 boolean isOpenVisible(java.awt.Frame owner)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the visiblity status of the open context menu action
 boolean isPluginInstalled(java.lang.String pluginName)
          Determines if a specified Operations Navigator plug-in is installed.
 boolean isSubcomponentInstalled(int option)
          Deprecated. in V5R1, replaced by UIServices.isComponentInstalled().
 boolean launchDefaultBrowser(java.lang.String url)
          Launches the default web browser using the provided URL.
 boolean launchHelpTopics()
          Launches the OpNav Help Topics splash screen.
 boolean launchHelpTopics(boolean showErrorMessage)
          Launches the OpNav Help Topics splash screen.
 boolean launchInfoCenter()
          Launches the infoCenter.
 boolean launchInfoCenter(boolean showErrorMessage)
          Launches the infoCenter.
 void refreshAll(java.awt.Frame owner, java.lang.String text)
          Refreshes the contents of both the tree and list windows of the Operations Navigator.
 void refreshList(java.awt.Frame owner, java.lang.String text)
          Refreshes the contents of the list view window of the Operations Navigator.
 void refreshList(java.awt.Frame owner, java.lang.String text, int top, int bottom)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Refreshes the contents of the list view window of the Operations Navigator.
 void refreshListHidden(java.awt.Frame owner, ObjectName objectname, java.lang.String text, int[] items)
          Refreshes the contents of the hidden list view window of the Operations Navigator.
 void refreshListItems(java.awt.Frame owner, java.lang.String text)
          Refreshes the currently selected item(s) in the list view window of the Operations Navigator.
 void refreshListItems(java.awt.Frame owner, java.lang.String text, int[] items)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Refreshes the input item(s) in the list view window of the Operations Navigator.
 void refreshTree(java.awt.Frame owner, ObjectName objectname, java.lang.String text)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Refreshes the subtree starting at the node identified by objectName All tree nodes and associated lists will be refreshed from the objectNode recursively in the console window.
 void refreshTreeItem(java.awt.Frame owner, ObjectName objectname)
          Refreshes the specified item in the tree of the Operations Navigator.
 boolean selectObject(java.awt.Frame owner, ObjectName[] objectNames, int target)
          THIS METHOD IS CURRENTLY NOT SUPPORTED This method causes the console to select the item passed in as the objectName Selecting an item will cause the toolbar and menubar's to update for the newly selected item
 void setDefaultListHeading(java.awt.Frame owner, java.lang.String treeHeading)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Updates the DefaultTreeHeading text
 void setDefaultTreeHeading(java.awt.Frame owner, java.lang.String treeHeading)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Updates the DefaultTreeHeading text
 void setExploreFromHereVisible(java.awt.Frame owner, boolean visible)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Changes the visibility of the explore from here action on the context menu
 void setExploreVisible(java.awt.Frame owner, boolean visible)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Changes the visibility of the explore action on the context menu
 void setFrameIcon(java.awt.Frame owner, java.awt.Image icon)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Updates the values in the status bar object coutner
 void setFrameTitle(java.awt.Frame owner, java.lang.String title)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Sets the title of the frame
 void setListHeading(java.awt.Frame owner, java.lang.String treeHeading)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Updates the treeHeading text
 void setOpenVisible(java.awt.Frame owner, boolean visible)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Changes the visibility of the open action on the context menu
 void setSecureConnection(java.awt.Frame owner, boolean secureConnection)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Turns on and off the secure connection icon in lower left of the Operations Navigator frame window to indicate that a secure connection is being used.
 void setStatusBarObjectCount(java.awt.Frame owner, int a, int b, int c, boolean d)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Updates the values in the status bar object coutner
 void setTaskPadPaneVisible(java.awt.Frame owner, boolean showTPad)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Sets the visibilty of Task Pad Pane in the frame
 void setTreeHeading(java.awt.Frame owner, java.lang.String treeHeading)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Updates the treeHeading text
 void setTreePaneVisible(java.awt.Frame owner, boolean showTree)
          THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Sets the visibilty of Tree Pane in the frame
 void setWaitCursor(boolean waitCursor)
          Sets the application wait cursor.
 void setWaitCursor(java.awt.Frame owner, boolean waitCursor)
          Sets the application wait cursor for an input frame.
 void showJavaWindow(java.awt.Window owner, java.lang.Boolean show)
          This is an internal method NOT CURRENTLY SUPPORTED for general use.
 boolean synchronizeHostCredentials(java.lang.Object systemObject, java.lang.String appName)
          Updates the credentials of an unconnected system object.
static java.lang.String toInitialUpper(java.lang.String s)
          Converts a String to initial character upper case and remaining characters lower case.
 void updateCurrentMenubar(java.awt.Frame owner, ActionDescriptor action)
          THIS METHOD IS CURRENTLY NOT SUPPORTED makes changes to the current menubar.
 void updateCurrentToolbar(java.awt.Frame owner, ActionDescriptor action)
          THIS METHOD IS CURRENTLY NOT SUPPORTED makes changes to the current toolbar.
 void updateStatusArea(java.awt.Frame owner, java.lang.String text)
          Writes a message to the application's status area.
 boolean updateTimerText(ObjectName objectName, java.util.Calendar updateTime, int updateType)
          Update the Operations Navigator timer text.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TREE_ITEM

public static final int TREE_ITEM
THIS METHOD IS CURRENTLY NOT SUPPORTED Selection target. Indicates target location for selectObject method TREE_ITEM is specified for selecting an item in the left pane (tree node)

LIST_ITEM

public static final int LIST_ITEM
THIS METHOD IS CURRENTLY NOT SUPPORTED Selection target. Indicates target location for selectObject method LIST_ITEM is specified for selecting an item in the right pane (list item)
Constructor Detail

UIServices

public UIServices()
Construct the UIServices object.
Method Detail

DebugOutput

public static void DebugOutput(java.lang.String outstring)

checkAS400Name

public boolean checkAS400Name(java.lang.String AS400Name,
                              java.lang.String systemName,
                              int typeID)
                       throws UIServicesException
Check the AS400 name
Parameters:
AS400Name - The AS/400 name whose validity is to be checked
SystemName - The name of the AS/400 system on which to perform the check
typeID - A numeric value which indicates how the input string should be interpreted
Returns:
True if the name is okay; False otherwise
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
CheckAS400NameConstants

checkObjectAuthority

public boolean checkObjectAuthority(java.lang.String objectPath,
                                    java.lang.String objectType,
                                    java.lang.String authorityType,
                                    java.lang.String systemName)
                             throws UIServicesException
Returns an indication of whether the Operations Navigator user has authority to a particular object on the AS/400.
Parameters:
objectPath - The AS/400 object path for which authority is to be checked
objectType - The AS/400 object type for the object for which authority is to be checked, for example *DTAQ
authorityType - The AS/400 object authority to be checked.

If more than one authority is to be checked, the authorities should be concatenated, i.e. AS400Constants.OBJMGT+AS400Constants.OBJEXIST.. Up to eleven authority types may be specified on a single call; the function will return CWB_OK only if the user has all of the specified authorities to the object.

systemName - The name of the AS/400 system on which to perform the check.
Returns:
True if the user has the authority; False otherwise.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
AS400Constants

checkSpecialAuthority

public boolean checkSpecialAuthority(java.lang.String specialAuthority,
                                     java.lang.String systemName)
                              throws UIServicesException
Returns an indication of whether the Operations Navigator user has a particular special authority on the AS/400.
Parameters:
specialAuthority - The AS/400 special authority to be checked.
systemName - The name of the AS/400 system on which to perform the check
Returns:
True if the user has the special authority; otherwise False
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
AS400Constants

displaySOAList

public boolean displaySOAList(java.lang.String systemName,
                              java.lang.String command,
                              boolean showErrorMessage)
                       throws UIServicesException
Deprecated. in V5R1, replaced by displaySOA specific functions.

Displays a System Object Access (SOA) list in a separate window. Possible lists include:
Parameters:
SystemName - The name of the AS/400 system where the requested list resides
command - The complete command containing the path, list command name, and parameters:
     ex: lstjob.exe /system Rchasp04 /jobtype I


     -----------------------------------------------------
     The following parameters are supported by lstjob.exe:

      /system system-name

          Specifies the name of the AS/400 system from which
          the list of jobs will be built.

          Examples: /system ROCH


      /job jobname

          Specifies a qualified OS/400 job name in the form
          jobnbr/user/jobname.  Only jobs whos job name match
          the specified job name will be included in the list.

          Job number special values for job number:

              *ALL means all jobs are included in the list
                  regardless of the job number value.

          User name special values for user name:

              *CURRENT means jobs whose user name matches the
                  current user profile name are included in
                  the list.
              *ALL means all jobs are included in the list
                  regardless of the user name value.

          Job name special values for job name:

              *ALL means all jobs are included in the list
                  regardless of the job name value.


          Examples: /job *ALL/RWATERS/*ALL
                    /job *ALL/*CURRENT/*ALL
                    /job *ALL/*ALL/DSP01

          If this parameter is not specified, all jobs for the
          current user are included in the list.

      /jobtype type-value

          Specifies the type of jobs to be included in the
          list.  One of the following special values must be
          specified.

          *   Jobs are included in the list regardless of type.
          A   Only autostart jobs are included in the list.
          B   Only batch jobs are included in the list.
          I   Only interactive jobs are included in the list.
          M   Only subsystem monitor jobs are included in list.
          R   Only spooled reader jobs are included in the list.
          S   Only system jobs are included in the list.
          W   Only spooled writer jobs are included in the list.
          X   Only the SCPF job is included in the list.

          Examples: /jobtype *
                    /jobtype B

          If this parameter is not specified, B is used for a
          default.

      /queued queued-jobs-value

          Specifies whether jobs on job queues are to be
          included in the list.

          One of the following special values must be specified.

              *ALL   Jobs on job queues are included in the list.
              *NONE  Jobs on job queues are not included in list.

          Examples: /queued    *ALL
                    /queued    *NONE

          If this parameter is not specified, *ALL is used for
          a default.

      /active active-jobs-value

          Specifies whether active jobs are to be included in
          the list.

          One of the following special values must be specified.

              *ALL   Active jobs are included in the list.
              *NONE  Active jobs are not included in the list.

          Examples: /active    *ALL
                    /active    *NONE

          If this parameter is not specified, *ALL is used for
          a default.

      /completed completed-jobs-value

          Specifies whether completed jobs (with output
          waiting to print) are to be included in the list.

          One of the following special values must be
          specified

              *ALL   Completed jobs are included in the list.
              *NONE  Completed jobs are not included in the list.

          Examples: /completed *ALL
                    /completed *NONE

          If this parameter is not specified, *NONE is used
          for a default.

      /jobq jobq<,jobq,...>

          Specifies one or more job queses whose jobs are to
          be included in the list.

          Examples: /jobq QBATCH
                    /jobq QGPL/QBATCH,*LIBL/QBATCH2
                    /jobq *ALL

          If this parameter is not specified, *ALL is used for
          a default.

      /sort column1,column2,column3...

          Specifies one or more column names by which to sort
          the list.  Column names must be one of the following
          names or integers.

              Name            Integer for shorthand

              NAME            1
              USER            2
              NUMBER          3
              TYPE            4
              SUBTYPE         5
              STATUS          6
              DATE            7
              TIME            8
              JOBQ            9
              JOBQLIB         10
              JOBQPTY         11
              OUTQPTY         12
              RUNPTY          13
              SBS             14
              SBSLIB          15
              POOLID          16
              CPUUSED         17
              AUXIO           18
              TRANS           19
              RESPONSE        20

          If multiple column names are provided they must be
          separated by commas with no intervening blanks.

          Examples: /sort USER,TYPE,DATE
                    /sort 2,4,7

          If this parameter is not specified, the jobs will be
          displayed in the default order created by OS/400.

      /disallowactions action1,action2,action3...

          Specifies one or more action names the user will NOT
          be allowed to perform on the jobs in the list.
          Action names must be one of the following names or
          integers.

              Name            Integer for shorthand

              HOLD            1
              DELETE          2
              RELEASE         3
              PROPERTIES      4
              REPLYMSG        5
              HELP            6
              MOVE            7
              OUTPUT          8
              JOBLOG          9

          If multiple action names are provided they must be
          separated by commas with no intervening blanks.

          Examples: /disallowactions DELETE,JOBLOG
                    /disallowactions 2,9

          If this parameter is not specified, the user will be
          allowed to perform all of the actions (unless the
          user is prohibited through OS/400 authority values).

      /disallowfilter  Y | N

          Disallows the user from changing the filter values
          via the "Include..." item of the "View" pull-down
          menu.

          Examples: /disallowfilter Y

      /listtype type-value

          Specifies the type of jobs list to be displayed. One
          of the following special values must be specified.

              A   All jobs
              S   Server jobs

          Examples: /listtype A
                    /listtype S

          If this parameter is not specified, A is used for a
          default.

      /currentuser type-value

          Specifies the current user(s) for the jobs in the list.
          This parameter is only allowed if /listtype S is
          specified (Server jobs)

          Examples: /currentuser TLK
                    /currentuser TLK,JRSMITH

          If this parameter is not specified, server jobs for all
          current users are shown.

      /primarystatus type-value

          Specifies the primary status(s) for the jobs in the
          list. This parameter is only allowed if /listtype S is
          specified (Server jobs)

          Examples: /primarystatus *ACTIVE
                    /primarystatus *ACTIVE,*JOBQ
                /primarystatus *OUTQ
                /primarystatus *ALL

          If this parameter is not specified, only *ACTIVE server
          jobs are shown



     ------------------------------------------------------
     The following parameters are supported by lstsplf.exe:

      /system system-name

          Specifies the name of the AS/400 system from which
          the list of spooled files will be built.

          Examples: /system ROCH

      /user user1,user2,user3...

          Specifies one or more user profile names whose
          spooled files will be included in the list.  If
          multiple user names are provided they must be
          separated by commas with no intervening blanks.

          Examples: /user RWATERS
                    /user DGILMOUR,NMASON,RWRIGHT,RWATERS
                    /user *ALL
                    /user *CURRENT    (default)

      /outq outq1,outq2,outq3...

          Specifies one or more output queue names whose
          spooled files will be included in the list.  The
          output queue name must be in the form
          "library/queue" (without the quotes).  If multiple
          queue names are provided they must be separated by
          commas with no intervening blanks.

          Examples: /outq *LIBL/PRT01
                    /outq QUSRSYS/PRT01,QUSRSYS/PRT02
                    /outq *ALL        (default)

      /formtype formtype

          Specifies a formtype value.  Only spooled files with
          a matching form type will be included in the list.

          Examples: /formtype 1040A
                    /formtype *ALL    (default)

      /usrdta userdata

          Specifies a user-specified data value.  Only spooled
          files with a matching user-specified data will be
          included in the list.

          Examples: /usrdta CLASSLIST
                    /usrdta *ALL      (default)

      /status status1,status2,status3...

          Specifies one or more spooled file status values.
          Only spooled files with a matching status will be
          included in the list.  If multiple status values are
          provided they must be separated by commas with no
          intervening blanks.

          Examples: /status *READY,*HELD
                    /status *ALL      (default)

      /printer printer1,printer2,printer3...

          Specifies one or more printer names.  Only spooled
          files assigned to one of the specified printers will
          be included in the list.  If multiple printers are
          provided they must be separated by commas with no
          intervening blanks.

          Examples: /printer ACCTNG,PAYROLL
                    /printer *ALL     (default)

      /job jobname

          Specifies a qualified OS/400 job name.  Only spooled
          files created by the specified job name will be
          included in the list.

          Examples: /job 012345/RWATERS/DSP01
                    /job *            (current job)

          If this parameter is not specified, spooled files
          are included in the list regardless of the creating
          job.

      /sort column1,column2,column3...

          Specifies one or more column names by which to sort
          the list.  Column names must be one of the following
          names or integers.

              Name            Integer for shorthand

              FILENAME        1
              JOBNAME         2
              USERNAME        3
              JOBNUMBER       4
              FILENUMBER      5
              OUTQ            6
              OUTQLIB         7
              PRINTER         8
              USERDATA        9
              STATUS          10
              PAGES           11
              COPIES          12
              FORMTYPE        13
              PRIORITY        14
              DATE            15
              TIME            16

          If multiple column names are provided they must be
          separated by commas with no intervening blanks.

          Examples: /sort USERNAME,DATE,TIME
                    /sort 3,15,16

          If this parameter is not specified, they spooled
          files will be displayed in the default order created
          by OS/400.

      /disallowactions action1,action2,action3...

          Specifies one or more action names the user will NOT
          be allowed to perform on the spooled files in the
          list.  Action names must be one of the following
          names or integers.

              Name            Integer for shorthand

              PRINTNEXT       1
              SEND            2
              HOLD            3
              DELETE          4
              OPEN            5
              RELEASE         6
              PROPERTIES      7
              REPLYMSG        8
              HELP            9
              MOVE            10
              RESTART         11

          If multiple action names are provided they must be
          separated by commas with no intervening blanks.

          Examples: /disallowactions DELETE,PRINTNEXT,MOVE
                    /disallowactions 4,1,10,7

          If this parameter is not specified, the user will be
          allowed to perform all of the actions (unless the
          user is prohibited through OS/400 authority values).

      /disallowfilter  Y | N

          Disallows the user from changing the filter values
          via the "Include..." item of the "View" pull-down
          menu.

          Examples: /disallowfilter Y



     -----------------------------------------------------
     The following parameters are supported by lstmsg.exe:

      /system system-name

          Specifies the name of the AS/400 system from which
          the list of messages will be built.

          Examples: /system ROCH

      /severity severity-value

          Specifies the minimum severity of a message to be
          included in the list.  The value specified must be
          between 0 and 99, inclusive.

          Examples: /severity 10

          If this parameter is not specified, 0 will be used
          as a default.

      /user user-name | *CURRENT

          Specifies a user name whose messages will be
          included in the list.

          Special values for user name:

              *CURRENT means messages for the current
                  user profile name are included in the list.


          Examples: /user *CURRENT
                    /user RWATERS

          If this parameter is not specified, *CURRENT will be
          used as a default.

      /disallowactions action1,action2,action3...

          Specifies one or more action names the user will NOT
          be allowed to perform on the messages in the list.
          Action names must be one of the following names or
          integers.

              Name            Integer for shorthand

              DELETE          1
              OPEN            2
              PROPERTIES      3
              REPLYMSG        4
              HELP            5

          If multiple action names are provided they must be
          separated by commas with no intervening blanks.

          Examples: /disallowactions HELP
                    /disallowactions 1

          If this parameter is not specified, the user will be
          allowed to perform all of the actions (unless the
          user is prohibited through OS/400 authority values).

      /disallowfilter  Y | N

          Disallows the user from changing the filter values
          via the "Include..." item of the "View" pull-down
          menu.

          Examples: /disallowfilter Y



     -----------------------------------------------------
     The following parameters are supported by lstprt.exe:

      /system system-name

          Specifies the name of the AS/400 system from which the
          list of printers will be built.

          Examples: /system ROCH

      /printer printer1,printer2,printer3...

          Specifies one or more printer names to be included
          in the list.  If multiple printers are provided they
          must be separated by commas with no intervening
          blanks.

          Examples: /printer ACCTNG,PAYROLL
                    /printer *ALL     (default)

      /disallowactions action1,action2,action3...

          Specifies one or more action names the user will NOT
          be allowed to perform on the printers in the list.
          Action names must be one of the following names or
          integers.

              Name            Integer for shorthand

              HOLD            1
              RELEASE         2
              PROPERTIES      3
              REPLYMSG        4
              HELP            5
              RESTART         6
              OUTPUT          7
              START           8
              STOP            9
              AVAIL           10
              UNAVAIL         11

          If multiple action names are provided they must be
          separated by commas with no intervening blanks.

          Examples: /disallowactions AVAIL,UNAVAIL
                    /disallowactions 9,10

          If this parameter is not specified, the user will be
          allowed to perform all of the actions (unless the
          user is prohibited through OS/400 authority values).

      /disallowfilter   Y | N

          Disallows the user from changing the filter values
          via the "Include..." item of the "View" pull-down
          menu.

          Examples: /disallowfilter Y



     -----------------------------------------------------
     The following parameters are supported by lstjbl.exe:

      /system system-name

          Specifies the name of the AS/400 system on which the
          job resides

          Examples: /system RCHAS1


      /job jobname

          Specifies a qualified OS/400 job name in the form
          jobnbr/user/jobname.


          Example: /job 014369/QUSER/DSP01
 
showErrorMessage - Indicator of whether to show error messages to the user if an error occurs on the CreateProcess API.
Returns:
True If the command runs successfully; False otherwise
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

displaySOAJob

public boolean displaySOAJob(java.lang.String systemName,
                             java.lang.String targetSystem,
                             java.lang.String jobName,
                             int jobType,
                             boolean queuedJobs,
                             boolean activeJobs,
                             boolean completedJobs,
                             java.lang.String[] jobQueue,
                             int[] sortColumn,
                             int[] disallowActions,
                             boolean disallowFilter,
                             boolean allJobs,
                             java.lang.String[] currentUser,
                             java.lang.String[] primaryStatus,
                             boolean showErrorMessage)
                      throws UIServicesException
Display an SOA Job
Parameters:
systemName - the name of the system to run the command on.
targetSystem - the name of the system where the data will be collected
jobName - the name of the job to be displayed
jobType - the type of job to be displayed
queuedJobs - whether queued jobs should be displayed
activeJobs - whether active jobs should be displayed
completedJobs - whether completed jobs should be displayed
jobQueue - the list of job queues to use
sortColumn - the list of columns to use for sorting the returned data
disallowActions - the list of actions to disallow
disallowFilter - whether to use the disallow filter
allJobs - whether to display all jobs
currentUser - the list of users to use for the display
primaryStatus - the status of the job(s)
showErrorMessage - whether to display error messages to the user
Returns:
True If the command runs successfully; False otherwise
Throws:
UIServicesException - if there is an error
Since:
v5r1m0
See Also:
DisplaySOAJobDisallowActionsConstants, DisplaySOAJobJobTypeConstants, DisplaySOAJobSortColumnConstants

displaySOAJobLog

public boolean displaySOAJobLog(java.lang.String systemName,
                                java.lang.String targetSystem,
                                java.lang.String jobName,
                                boolean showErrorMessage)
                         throws UIServicesException
Display an SOA Job Log
Parameters:
systemName - the name of the system to run the command on.
targetSystem - the name of the system where the data will be collected
jobName - the name of the job to be displayed
showErrorMessage - whether to display error messages to the user
Returns:
True If the command runs successfully; False otherwise
Throws:
UIServicesException - if there is an error
Since:
v5r1m0

displaySOAMessage

public boolean displaySOAMessage(java.lang.String systemName,
                                 java.lang.String targetSystem,
                                 int severity,
                                 java.lang.String userName,
                                 int[] disallowActions,
                                 boolean disallowFilter,
                                 boolean showErrorMessage)
                          throws UIServicesException
Display an SOA Message
Parameters:
systemName - the name of the system to run the command on.
targetSystem - the name of the system where the data will be collected
severity - the severity of the message(s) to be displayed
userName - the name of the user for the message(s) to be displayed
disallowActions - the list of actions to disallow
disallowFilter - whether to use the disallow filter
showErrorMessage - whether to display error messages to the user
Returns:
True If the command runs successfully; False otherwise
Throws:
UIServicesException - if there is an error
Since:
v5r1m0
See Also:
DisplaySOAMessageDisallowActionsConstants

displaySOAPrinter

public boolean displaySOAPrinter(java.lang.String systemName,
                                 java.lang.String targetSystem,
                                 java.lang.String[] printerName,
                                 int[] disallowActions,
                                 boolean disallowFilter,
                                 boolean showErrorMessage)
                          throws UIServicesException
Display an SOA Printer
Parameters:
systemName - the name of the system to run the command on.
targetSystem - the name of the system where the data will be collected
printerName - the list of printers to display
disallowActions - the list of actions to disallow
disallowFilter - whether to use the disallow filter
showErrorMessage - whether to display error messages to the user
Returns:
True If the command runs successfully; False otherwise
Throws:
UIServicesException - if there is an error
Since:
v5r1m0
See Also:
DisplaySOAPrinterDisallowActionsConstants

displaySOASpooledFile

public boolean displaySOASpooledFile(java.lang.String systemName,
                                     java.lang.String targetSystem,
                                     java.lang.String[] userProfileName,
                                     java.lang.String[] outQueue,
                                     java.lang.String formType,
                                     java.lang.String userData,
                                     java.lang.String[] status,
                                     java.lang.String[] printerName,
                                     java.lang.String jobName,
                                     int[] sortColumn,
                                     int[] disallowActions,
                                     boolean disallowFilter,
                                     boolean showErrorMessage)
                              throws UIServicesException
Display an SOA Spooled File
Parameters:
systemName - the name of the system to run the command on.
targetSystem - the name of the system where the data will be collected
userProfileName - the name of the user(s) who owns the spooled file(s)
outQueue - the list of output queues to display
formType - the form type to display
userData - the user data to display
status - the list of status values to display
printerName - the list of printers to display
jobName - the name of the job to display
sortColumn - the list of columns to use for sorting the returned data
disallowActions - the list of actions to disallow
disallowFilter - whether to use the disallow filter
showErrorMessage - whether to display error messages to the user
Returns:
True If the command runs successfully; False otherwise
Throws:
UIServicesException - if there is an error
Since:
v5r1m0
See Also:
DisplaySOASpooledFileSortColumnConstants, DisplaySOASpooledFileDisallowActionsConstants

getAdminCacheState

public int getAdminCacheState(java.lang.String systemName)
                       throws UIServicesException
Returns the admin cache state on the specified system.
Parameters:
systemName - The name of the AS/400 system on which to return the admin cache state.
Returns:
GetAdminCacheStateConstants.LOGON (System needs to logon because there is no current user.) GetAdminCacheStateConstants.REFRESH (System cache needs to be updated.) GetAdminCacheStateConstants.CACHE (System cache is current. The call should be quick.)
Throws:
UIServicesException - if there is an error
Since:
v4r5m0
See Also:
GetAdminCacheStateConstants

getAdminValue

public int getAdminValue(java.lang.String systemName,
                         java.lang.String adminFunction)
                  throws UIServicesException
Returns the admin value for the specified admin function on the specified system.
Parameters:
systemName - The name of the AS/400 system on which to return the admin value.
adminFunction - The name of the admin value.
Returns:
the admin value specified.
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

getHostAdminValue

public int getHostAdminValue(java.lang.String systemName,
                             java.lang.String adminFunction)
                      throws UIServicesException
Returns the admin value for the specified 'Host' category admin function on the specified system.
Parameters:
systemName - The name of the AS/400 system on which to return the admin value.
adminFunction - The name of the admin value.
Returns:
the admin value specified.
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

getCentralSystemName

public java.lang.String getCentralSystemName()
                                      throws UIServicesException
Returns the system name of the current central system.
Returns:
The name of the current central system
Throws:
UIServicesException - if there is an error
Since:
v5r1m0

getCurrentLanguageName

public java.lang.String getCurrentLanguageName()
                                        throws UIServicesException
Returns the descriptive name of the current language setting.
Returns:
The descriptive name of the current language setting
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

getLanguageName

public java.lang.String getLanguageName(java.lang.String featureCode)
                                 throws UIServicesException
Returns the descriptive name of the language setting. The value is based on the AS/400 feature code provided.
Parameters:
featureCode - the AS/400 feature code for which the language name should be retrieved.
Returns:
The descriptive name of the language setting
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

getFileSystemName

public java.lang.String getFileSystemName(ObjectName objectName)
                                   throws UIServicesException
Returns the file system name of the object, provided the object resides in the file system.
Parameters:
objectName - the name of the object.
Returns:
file system name
Throws:
UIServicesException - if there is an error
Since:
v5r1m0

getSystemValue

public java.lang.String getSystemValue(int value,
                                       java.lang.String systemName)
                                throws UIServicesException
Returns a string containing the value of an AS/400 system value.
Parameters:
value - A numeric value which identifies the AS/400 system value to be retrieved.
systemName - The name of the AS/400 from which the system value should be retrieved
Returns:
The system value string NOTE: The value returned by this API is NOT an NLS string and is not translated. For example, '*NONE' will be returned instead of 'None'.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
GetSystemValueConstants

getUserAttribute

public java.lang.String getUserAttribute(int attributeId,
                                         java.lang.String systemName)
                                  throws UIServicesException
Returns a string containing the value of a user profile attribute for the current Operations Navigator user.
Parameters:
attributeId - A numeric value which identifies the user attribute value to be retrieved.
systemName - The name of the AS/400 system on which to retrieve the user attribute.
Returns:
The user attribute.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
GetUserAttributeConstants

getVersion

public int getVersion()
Returns the version of the com.ibm.as400.opnav package.
Returns:
The com.ibm.as400.opnav version
Since:
v4r4m0

isConnected

public boolean isConnected(java.lang.String systemName)
                    throws UIServicesException
Determine if there is connection to the specified system
Parameters:
systemName - The name of the AS/400 system to check.
Returns:
True if a connection exists; False otherwise.
Throws:
UIServicesException - if there is an error
Since:
v5r1m0

isConnected

public boolean isConnected(java.lang.String systemName,
                           java.lang.String appName)
                    throws UIServicesException
Determine if there is connection to the specified system
Parameters:
systemName - The name of the AS/400 system to check.
appName - The app name of the AS/400 connection.
Returns:
True if a connection exists; False otherwise.
Throws:
UIServicesException - if there is an error
Since:
v5r1m0

isConnectionTypeTCPIP

public boolean isConnectionTypeTCPIP(java.lang.String systemName)
                              throws UIServicesException
Determine if the system connection is using TCP/IP for communications
Parameters:
systemName - The name of the AS/400 system which will be checked to determine if a TCP/IP connection is being used.
Returns:
True if TCP/IP is being used; False otherwise.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0

isComponentInstalled

public boolean isComponentInstalled(int option)
                             throws UIServicesException
Determines if a specified Operations Navigator component is installed.
Parameters:
option - Specification of the Operations Navigator component to check.
Returns:
True if the component is installed; False otherwise.
Throws:
UIServicesException - if there is an error
Since:
v5r1m0
See Also:
IsComponentInstalledConstants

isPluginInstalled

public boolean isPluginInstalled(java.lang.String pluginName)
                          throws UIServicesException
Determines if a specified Operations Navigator plug-in is installed.
Parameters:
pluginName - Name of the Operations Navigator plug-in to check.
Returns:
True if the plug-in is installed; False otherwise.
Throws:
UIServicesException - if there is an error
Since:
v5r1m0

isSubcomponentInstalled

public boolean isSubcomponentInstalled(int option)
                                throws UIServicesException
Deprecated. in V5R1, replaced by UIServices.isComponentInstalled().

Determines if a specified Operations Navigator Install option is installed.
Parameters:
option - Specification of the Operations Navigator option to check.
Returns:
True if the subcomponent is installed; False otherwise.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
IsSubcomponentInstalledConstants

launchDefaultBrowser

public boolean launchDefaultBrowser(java.lang.String url)
                             throws UIServicesException
Launches the default web browser using the provided URL.
Parameters:
url - The URL to view.
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

launchInfoCenter

public boolean launchInfoCenter(boolean showErrorMessage)
                         throws UIServicesException
Launches the infoCenter.
Parameters:
showErrorMessage - whether to show error messages to the user.
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

launchInfoCenter

public boolean launchInfoCenter()
                         throws UIServicesException
Launches the infoCenter. This method shows error messages to the user.
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

launchHelpTopics

public boolean launchHelpTopics(boolean showErrorMessage)
                         throws UIServicesException
Launches the OpNav Help Topics splash screen.
Parameters:
showErrorMessage - whether to show error messages to the user.
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

launchHelpTopics

public boolean launchHelpTopics()
                         throws UIServicesException
Launches the OpNav Help Topics splash screen. This method shows error messages to the user.
Throws:
UIServicesException - if there is an error
Since:
v4r5m0

refreshTree

public void refreshTree(java.awt.Frame owner,
                        ObjectName objectname,
                        java.lang.String text)
                 throws UIServicesException
THIS METHOD IS CURRENTLY NOT SUPPORTED Refreshes the subtree starting at the node identified by objectName All tree nodes and associated lists will be refreshed from the objectNode recursively in the console window.
Parameters:
owner - The window frame to refresh.
objectname - The name of the object in the tree to refresh.
text - A string to be placed in the status area upon completion. This parameter may be null.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
ActionsManager, DropTargetManager

refreshAll

public void refreshAll(java.awt.Frame owner,
                       java.lang.String text)
                throws UIServicesException
Refreshes the contents of both the tree and list windows of the Operations Navigator.
Parameters:
owner - The window frame to refresh.
text - A string to be placed in the status area upon completion. This parameter may be null.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
ActionsManager, DropTargetManager

refreshList

public void refreshList(java.awt.Frame owner,
                        java.lang.String text)
                 throws UIServicesException
Refreshes the contents of the list view window of the Operations Navigator.
Parameters:
owner - The window frame to refresh.
text - A string to be placed in the status area upon completion. This parameter may be null.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
ActionsManager, DropTargetManager

refreshListHidden

public void refreshListHidden(java.awt.Frame owner,
                              ObjectName objectname,
                              java.lang.String text,
                              int[] items)
                       throws UIServicesException
Refreshes the contents of the hidden list view window of the Operations Navigator.
Parameters:
owner - The window frame to refresh.
objectname - The name of the object to refresh.
text - A string to be placed in the status area upon completion. This parameter may be null.
items - An array of items to be refreshed.
Throws:
UIServicesException - if there is an error
Since:
v4r5m0
See Also:
ActionsManager, DropTargetManager

refreshTreeItem

public void refreshTreeItem(java.awt.Frame owner,
                            ObjectName objectname)
                     throws UIServicesException
Refreshes the specified item in the tree of the Operations Navigator.
Parameters:
owner - The window frame to refresh.
objectname - The name of the object to refresh.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
ActionsManager, DropTargetManager

refreshListItems

public void refreshListItems(java.awt.Frame owner,
                             java.lang.String text)
                      throws UIServicesException
Refreshes the currently selected item(s) in the list view window of the Operations Navigator.
Parameters:
owner - The window frame to refresh.
text - A string to be placed in the status area upon completion. This parameter may be null.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
ActionsManager, DropTargetManager

refreshListItems

public void refreshListItems(java.awt.Frame owner,
                             java.lang.String text,
                             int[] items)
                      throws UIServicesException
THIS METHOD IS CURRENTLY NOT SUPPORTED Refreshes the input item(s) in the list view window of the Operations Navigator.
Parameters:
owner - The window frame to refresh.
text - A string to be placed in the status area upon completion. This parameter may be null.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
ActionsManager, DropTargetManager

setWaitCursor

public void setWaitCursor(boolean waitCursor)
                   throws UIServicesException
Sets the application wait cursor.
Parameters:
waitCursor - True If the cursor should be turned on; False otherwise
Throws:
UIServicesException - if there is an error

setWaitCursor

public void setWaitCursor(java.awt.Frame owner,
                          boolean waitCursor)
                   throws UIServicesException
Sets the application wait cursor for an input frame.
Parameters:
waitCursor - True If the cursor should be turned on; False otherwise
owner - The window frame to change the cursor in.
Throws:
UIServicesException - if there is an error

toInitialUpper

public static java.lang.String toInitialUpper(java.lang.String s)
Converts a String to initial character upper case and remaining characters lower case.
Parameters:
s - the String to be converted.
Returns:
a new String containing the converted characters.
Since:
v4r5m0

synchronizeHostCredentials

public boolean synchronizeHostCredentials(java.lang.Object systemObject,
                                          java.lang.String appName)
                                   throws UIServicesException
Updates the credentials of an unconnected system object.
Parameters:
systemObject - The system object
appName - The app name of the AS/400 connection.
Returns:
True if the credentials were modified; False otherwise
Throws:
UIServicesException - if there is an error
Since:
v5r1m0

updateStatusArea

public void updateStatusArea(java.awt.Frame owner,
                             java.lang.String text)
                      throws UIServicesException
Writes a message to the application's status area. The details of where the status area is displayed or how it is updated are dependent on the UI platform.
Parameters:
owner - The window frame to update.
text - A string to be placed in the status area.
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
ActionsManager, DropTargetManager

setStatusBarObjectCount

public void setStatusBarObjectCount(java.awt.Frame owner,
                                    int a,
                                    int b,
                                    int c,
                                    boolean d)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Updates the values in the status bar object coutner
Parameters:
owner - The window frame to change the cursor in.
a -  
b -  
c -  
d -  
Throws:
UIServicesException - if there is an error

setFrameTitle

public void setFrameTitle(java.awt.Frame owner,
                          java.lang.String title)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Sets the title of the frame
Parameters:
owner - The window frame to change the cursor in.
title - The new title for the window

getFrameTitle

public java.lang.String getFrameTitle(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Gets the title of the frame
Parameters:
owner - The window frame to change the cursor in.

setFrameIcon

public void setFrameIcon(java.awt.Frame owner,
                         java.awt.Image icon)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Updates the values in the status bar object coutner
Parameters:
owner - The window frame to change the cursor in.
icon - The icon to be displayed in the upper left of the frame

getFrameIcon

public java.awt.Image getFrameIcon(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Gets the current frame icon
Parameters:
owner - The window frame to change the cursor in.

setDefaultTreeHeading

public void setDefaultTreeHeading(java.awt.Frame owner,
                                  java.lang.String treeHeading)
THIS METHOD IS CURRENTLY NOT SUPPORTED Updates the DefaultTreeHeading text
Parameters:
owner - The window frame to get the on/off state of the secure icon
treeHeading - The string you want the default tree heading to be
Returns:
void
Since:
v5r1m0

setTreeHeading

public void setTreeHeading(java.awt.Frame owner,
                           java.lang.String treeHeading)
THIS METHOD IS CURRENTLY NOT SUPPORTED Updates the treeHeading text
Parameters:
owner - The window frame to get the on/off state of the secure icon
actions - The actions you wish to make on the menubar
Returns:
void
Since:
v5r1m0

setDefaultListHeading

public void setDefaultListHeading(java.awt.Frame owner,
                                  java.lang.String treeHeading)
THIS METHOD IS CURRENTLY NOT SUPPORTED Updates the DefaultTreeHeading text
Parameters:
owner - The window frame to get the on/off state of the secure icon
treeHeading - The string you want the default tree heading to be
Returns:
void
Since:
v5r1m0

setListHeading

public void setListHeading(java.awt.Frame owner,
                           java.lang.String treeHeading)
THIS METHOD IS CURRENTLY NOT SUPPORTED Updates the treeHeading text
Parameters:
owner - The window frame to get the on/off state of the secure icon
actions - The actions you wish to make on the menubar
Returns:
void
Since:
v5r1m0

updateTimerText

public boolean updateTimerText(ObjectName objectName,
                               java.util.Calendar updateTime,
                               int updateType)
                        throws UIServicesException
Update the Operations Navigator timer text.
Parameters:
objectName - the name of the object to update.
updateTime - the time of the update event the value can be null.
updateType - the type of update event. The value of the parameter can be, UpdateTimerTextConstants.TimeLastCollected, UpdateTimerTextConstants.TimeLastChanged, or UpdateTimerTextConstants.TimeOfUpdateUnknown.
Returns:
True If the command runs successfully; False otherwise
Throws:
UIServicesException - if there is an error
Since:
v5r1m0
See Also:
UpdateTimerTextConstants

displayProperties

public void displayProperties(java.awt.Frame owner,
                              ObjectName objectName)
                       throws UIServicesException
Displays the system properties dialog for the specified object.
Parameters:
owner - The owning frame for the dialog.
objectName - The name of the object for which properties is to be displayed.
Throws:
UIServicesException - If an error occurs.
Since:
v5r1m0
See Also:
ObjectName

displayProperties2

public void displayProperties2(java.awt.Frame owner,
                               ObjectName objectName)
                        throws UIServicesException

getCachedObjectName

public ObjectName getCachedObjectName(java.lang.String componentType,
                                      java.lang.String objectType,
                                      java.lang.String parentType,
                                      java.lang.String displayName,
                                      java.lang.String parentName,
                                      java.lang.String systemName)
                               throws UIServicesException
Searches the cache of active ListManagers for an ObjectName that matches the input parameters.
Parameters:
componentType - the component folder type.
objectType - the object folder type
parentType - the parent folder type
displayName - the display name of the object folder - may be null
parentName - the display name of the parent folder - may be null
systemName - the display name of the system folder - may be null
Returns:
ObjectName
Throws:
UIServicesException - if there is an error
Since:
v5r1m0

setSecureConnection

public void setSecureConnection(java.awt.Frame owner,
                                boolean secureConnection)
THIS METHOD IS CURRENTLY NOT SUPPORTED Turns on and off the secure connection icon in lower left of the Operations Navigator frame window to indicate that a secure connection is being used.
Parameters:
owner - The window frame to use to enable/disable the secure icon
secureConnection - true=trun on the secure connection icon, false=turn off the secure connection icon.
Since:
v5r1m0
See Also:
getSecureConnection

getSecureConnection

public boolean getSecureConnection(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the state of the secure connection icon in lower left of the Operations Navigator frame window. This icon is used to indicate that a secure connection is being used.
Parameters:
owner - The window frame to get the on/off state of the secure icon
Returns:
true=secure connection icon is on, false=secure connection icon is off false=turn off the secure connection icon.
Since:
v5r1m0
See Also:
setSecureConnection

isExploreVisible

public boolean isExploreVisible(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the visiblity status of the explore context menu action
Parameters:
owner - The window frame to get the on/off state of the secure icon
Returns:
true=the explore context action is visible false=the explore context action is not visible
Since:
v5r1m0
See Also:
setSecureConnection

isExploreFromHereVisible

public boolean isExploreFromHereVisible(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the visiblity status of the explore from here context menu action
Parameters:
owner - The window frame to get the on/off state of the secure icon
Returns:
true=the explore from here context action is visible false=the explore from here context action is not visible
Since:
v5r1m0
See Also:
setSecureConnection

isOpenVisible

public boolean isOpenVisible(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the visiblity status of the open context menu action
Parameters:
owner - The window frame to get the on/off state of the secure icon
Returns:
true=the open context action is visible false=the open context action is not visible
Since:
v5r1m0
See Also:
setSecureConnection

setExploreVisible

public void setExploreVisible(java.awt.Frame owner,
                              boolean visible)
THIS METHOD IS CURRENTLY NOT SUPPORTED Changes the visibility of the explore action on the context menu
Parameters:
owner - The window frame to get the on/off state of the secure icon
visible - true=the explore context action is visible false=the explore context actions is not visible
Since:
v5r1m0
See Also:
setSecureConnection

setExploreFromHereVisible

public void setExploreFromHereVisible(java.awt.Frame owner,
                                      boolean visible)
THIS METHOD IS CURRENTLY NOT SUPPORTED Changes the visibility of the explore from here action on the context menu
Parameters:
owner - The window frame to get the on/off state of the secure icon
visible - true=the explore from here context action is visible false=the explore from here context actions is not visible
Since:
v5r1m0
See Also:
setSecureConnection

setOpenVisible

public void setOpenVisible(java.awt.Frame owner,
                           boolean visible)
THIS METHOD IS CURRENTLY NOT SUPPORTED Changes the visibility of the open action on the context menu
Parameters:
owner - The window frame to get the on/off state of the secure icon
visible - true=the open context action is visible false=the open context actions is not visible
Since:
v5r1m0
See Also:
setSecureConnection

updateCurrentToolbar

public void updateCurrentToolbar(java.awt.Frame owner,
                                 ActionDescriptor action)
THIS METHOD IS CURRENTLY NOT SUPPORTED makes changes to the current toolbar. Changes may be lost when when node selection changes
Parameters:
owner - The window frame to get the on/off state of the secure icon
action - an Action descriptor describing the action to be performed
Since:
v5r1m0
See Also:
ActionDescriptor

updateCurrentMenubar

public void updateCurrentMenubar(java.awt.Frame owner,
                                 ActionDescriptor action)
THIS METHOD IS CURRENTLY NOT SUPPORTED makes changes to the current menubar. Changes may be lost when when node selection changes
Parameters:
owner - The window frame to get the on/off state of the secure icon
action - an Action descriptor describing the action to be performed
Since:
v5r1m0
See Also:
ActionDescriptor

addListManager

public void addListManager(java.awt.Frame owner,
                           java.lang.String objType,
                           java.lang.String listManager)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ListManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the ListManager on
listManager - The fully qualified class name of the ListManager

addListManager

public void addListManager(java.awt.Frame owner,
                           java.lang.String objType,
                           java.lang.String listManager,
                           boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ListManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the ListManager on
listManager - The fully qualified class name of the ListManager
childrenSupported - Does this ListManager get applied to children of this node type

addContextMenuHandler

public void addContextMenuHandler(java.awt.Frame owner,
                                  java.lang.String objType,
                                  java.lang.String ContextMenuHandler)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ContextMenuHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the ContextMenuHandler on
ContextMenuHandler - The fully qualified class name of the ContextMenuHandler

addContextMenuHandler

public void addContextMenuHandler(java.awt.Frame owner,
                                  java.lang.String objType,
                                  java.lang.String ContextMenuHandler,
                                  boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ContextMenuHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the ContextMenuHandler on
ContextMenuHandler - The fully qualified class name of the ContextMenuHandler
childrenSupported - Does this ContextMenuHandler get applied to children of this node type

addPropertySheetHandler

public void addPropertySheetHandler(java.awt.Frame owner,
                                    java.lang.String objType,
                                    java.lang.String PropertySheetHandler)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a PropertySheetHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the PropertySheetHandler on
PropertySheetHandler - The fully qualified class name of the PropertySheetHandler

addPropertySheetHandler

public void addPropertySheetHandler(java.awt.Frame owner,
                                    java.lang.String objType,
                                    java.lang.String PropertySheetHandler,
                                    boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a PropertySheetHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the PropertySheetHandler on
PropertySheetHandler - The fully qualified class name of the PropertySheetHandler
childrenSupported - Does this PropertySheetHandler get applied to children of this node type

addToolbarButtonHandler

public void addToolbarButtonHandler(java.awt.Frame owner,
                                    java.lang.String objType,
                                    java.lang.String ToolbarButtonHandler)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ToolbarButtonHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the ToolbarButtonHandler on
ToolbarButtonHandler - The fully qualified class name of the ToolbarButtonHandler

addToolbarButtonHandler

public void addToolbarButtonHandler(java.awt.Frame owner,
                                    java.lang.String objType,
                                    java.lang.String ToolbarButtonHandler,
                                    boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ToolbarButtonHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the ToolbarButtonHandler on
ToolbarButtonHandler - The fully qualified class name of the ToolbarButtonHandler
childrenSupported - Does this ToolbarButtonHandler get applied to children of this node type

addMenubarActionHandler

public void addMenubarActionHandler(java.awt.Frame owner,
                                    java.lang.String objType,
                                    java.lang.String MenubarActionHandler)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a MenubarActionHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the MenubarActionHandler on
MenubarActionHandler - The fully qualified class name of the MenubarActionHandler

addMenubarActionHandler

public void addMenubarActionHandler(java.awt.Frame owner,
                                    java.lang.String objType,
                                    java.lang.String MenubarActionHandler,
                                    boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a MenubarActionHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the MenubarActionHandler on
MenubarActionHandler - The fully qualified class name of the MenubarActionHandler
childrenSupported - Does this MenubarActionHandler get applied to children of this node type

addTreeHeadingManager

public void addTreeHeadingManager(java.awt.Frame owner,
                                  java.lang.String objType,
                                  java.lang.String TreeHeadingManager,
                                  java.lang.String WhenCalled)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TreeHeadingManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the TreeHeadingManager on
TreeHeadingManager - The fully qualified class name of the TreeHeadingManager
whenCalled -  

addTreeHeadingManager

public void addTreeHeadingManager(java.awt.Frame owner,
                                  java.lang.String objType,
                                  java.lang.String TreeHeadingManager,
                                  java.lang.String WhenCalled,
                                  boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TreeHeadingManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the TreeHeadingManager on
TreeHeadingManager - The fully qualified class name of the TreeHeadingManager
whenCalled -  
childrenSupported - Does this TreeHeadingManager get applied to children of this node type

addListHeadingManager

public void addListHeadingManager(java.awt.Frame owner,
                                  java.lang.String objType,
                                  java.lang.String ListHeadingManager,
                                  java.lang.String WhenCalled)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ListHeadingManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the ListHeadingManager on
ListHeadingManager - The fully qualified class name of the ListHeadingManager
whenCalled -  

addListHeadingManager

public void addListHeadingManager(java.awt.Frame owner,
                                  java.lang.String objType,
                                  java.lang.String ListHeadingManager,
                                  java.lang.String WhenCalled,
                                  boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a ListHeadingManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the ListHeadingManager on
ListHeadingManager - The fully qualified class name of the ListHeadingManager
whenCalled -  
childrenSupported - Does this ListHeadingManager get applied to children of this node type

addDropHandler

public void addDropHandler(java.awt.Frame owner,
                           java.lang.String objType,
                           java.lang.String DropHandler)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a DropHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the DropHandler on
DropHandler - The fully qualified class name of the DropHandler

addDropHandler

public void addDropHandler(java.awt.Frame owner,
                           java.lang.String objType,
                           java.lang.String DropHandler,
                           boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a DropHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the DropHandler on
DropHandler - The fully qualified class name of the DropHandler
childrenSupported - Does this DropHandler get applied to children of this node type

addTaskPadHandler

public void addTaskPadHandler(java.awt.Frame owner,
                              java.lang.String objType,
                              java.lang.String taskPadHandler,
                              java.lang.String whenCalled,
                              java.lang.String[] cascadingVerbs)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskPadHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the TaskPadHandler on
taskPadHandler - The fully qualified class name of the TaskPadHandler

addTaskPadHandler

public void addTaskPadHandler(java.awt.Frame owner,
                              java.lang.String objType,
                              java.lang.String taskPadHandler,
                              java.lang.String whenCalled,
                              java.lang.String[] cascadingVerbs,
                              boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskPadHandler with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the TaskPadHandler on
taskPadHandler - The fully qualified class name of the TaskPadHandler
childrenSupported - Does this TaskPadHandler get applied to children of this node type

addTaskInformationManager

public void addTaskInformationManager(java.awt.Frame owner,
                                      java.lang.String objType,
                                      java.lang.String taskInfoMgr)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskInformationManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the TaskInformationManager on
taskInfoMgr - The fully qualified class name of the TaskInformationManager

addTaskInformationManager

public void addTaskInformationManager(java.awt.Frame owner,
                                      java.lang.String objType,
                                      java.lang.String taskInfoMgr,
                                      boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskInformationManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the TaskInformationManager on
taskInfoMgr - The fully qualified class name of the TaskInformationManager
childrenSupported - Does this TaskInformationManager get applied to children of this node type

addHelpSet

public void addHelpSet(java.awt.Frame owner,
                       java.lang.String objType,
                       java.lang.String helpSet,
                       java.lang.String helpID)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskInformationManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the TaskInformationManager on
helpSet - The name of the help set to be used
helpID - The ID of the help you want shown

addHelpSet

public void addHelpSet(java.awt.Frame owner,
                       java.lang.String objType,
                       java.lang.String helpSet,
                       java.lang.String helpID,
                       boolean childrenAffected)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Associates a TaskInformationManager with a node type
Parameters:
owner - The window frame to change the cursor in.
objType - The type of object to register the TaskInformationManager on
helpSet - The name of the help set to be used
helpID - The ID of the help you want shown
childrenSupported - Does this TaskInformationManager get applied to children of this node type

getTreePaneVisible

public boolean getTreePaneVisible(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Checks to see if the Tree Pane is visible in the frame
Parameters:
owner - The window frame to change the cursor in.

setTreePaneVisible

public void setTreePaneVisible(java.awt.Frame owner,
                               boolean showTree)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Sets the visibilty of Tree Pane in the frame
Parameters:
owner - The window frame to change the cursor in.
showTree - Do you want the TreePane visible

getTaskPadPaneVisible

public boolean getTaskPadPaneVisible(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Checks to see if the Task Pad Pane is visible in the frame
Parameters:
owner - The window frame to change the cursor in.

setTaskPadPaneVisible

public void setTaskPadPaneVisible(java.awt.Frame owner,
                                  boolean showTPad)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Sets the visibilty of Task Pad Pane in the frame
Parameters:
owner - The window frame to change the cursor in.
showTPad - Do you want the Task Pad visible

collapsePath

public void collapsePath(java.awt.Frame owner,
                         ObjectName objectName)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Collpases the path refered to by the ObjectName
Parameters:
owner - The window frame to change the cursor in.
objectName - ObjectName of the the node you want collapsed

expandPath

public void expandPath(java.awt.Frame owner,
                       ObjectName objectName)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Expands the path refered to by the ObjectName
Parameters:
owner - The window frame to change the cursor in.
objectName - ObjectName of the the node you want collapsed

isExpanded

public boolean isExpanded(java.awt.Frame owner,
                          ObjectName objectName)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Checks if the node refered to by the ObjectName is expanded
Parameters:
owner - The window frame to change the cursor in.
objectName - ObjectName of the the node you want collapsed

showJavaWindow

public void showJavaWindow(java.awt.Window owner,
                           java.lang.Boolean show)
                    throws UIServicesException
This is an internal method NOT CURRENTLY SUPPORTED for general use. btwatts 8-21-2000

getSystemList

public java.lang.String[] getSystemList()
                                 throws UIServicesException
Retrieve the persistent list of AS/400 systems configured on the installed client.

getDisplayedColumns

public int[] getDisplayedColumns(java.awt.Frame owner,
                                 ObjectName objectName)
THIS METHOD IS CURRENTLY NOT SUPPORTED lisadier 7-14-2000 This method returns the column ids of the currently displayed columns for the give type.
Parameters:
owner - The window frame to get the columns information from
objectName - The object whose type the columns information will be returned for
Returns:
Array of integers containing the column identifiers of the columns that are displayed for objects that have the same type as parameter objectName. An array of size 0 will be returned if no list has been constructed for the given objectName. (Thus, if this method is called from a ListManager constructor or initialize method, an array of size 0 will be returned. Column ids will be returned when this method is called from a ListManager open method or any time later.)
Since:
v5r1m0

closeWindow

public boolean closeWindow(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED * In Java framework only * * Closes the window
Parameters:
owner - The window frame to close.

selectObject

public boolean selectObject(java.awt.Frame owner,
                            ObjectName[] objectNames,
                            int target)
THIS METHOD IS CURRENTLY NOT SUPPORTED This method causes the console to select the item passed in as the objectName Selecting an item will cause the toolbar and menubar's to update for the newly selected item
Parameters:
owner - The window frame to get the columns information from
objectName - The object to be selected
Since:
v5r1m0

getSelectedWindow

public int getSelectedWindow(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED This method will return window that has the current focus, and selection
Parameters:
owner - The window frame
Returns:
item LIST_ITEM if the list right pane is selected, TREE_ITEM if the tree or left pane is selected, and -1 if the selection can not be determined
Since:
v5r1m0

getSelectedObjects

public ObjectName[] getSelectedObjects(java.awt.Frame owner)
THIS METHOD IS CURRENTLY NOT SUPPORTED This method will a list of items that are currently selected in the console
Parameters:
owner - The window frame
Returns:
item LIST_ITEM if the list right pane is selected, TREE_ITEM if the tree or left pane is selected, and -1 if the selection can not be determined
Since:
v5r1m0
See Also:
selectedObject

refreshList

public void refreshList(java.awt.Frame owner,
                        java.lang.String text,
                        int top,
                        int bottom)
                 throws UIServicesException
THIS METHOD IS CURRENTLY NOT SUPPORTED Refreshes the contents of the list view window of the Operations Navigator. This method also allows the caller to specify the list item(s) that will be selected after the refresh is complete
Parameters:
owner - The window frame to refresh.
text - A string to be placed in the status area upon completion. This parameter may be null.
top - The 1st item to be selected after the refresh is complete
bottom - The last item to be selected in the list after the refresh is complete
Throws:
UIServicesException - if there is an error
Since:
v4r4m0
See Also:
ActionsManager, DropTargetManager