com.ibm.as400.opnav
Class OpenWindowData

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

public class OpenWindowData
extends java.lang.Object

The class that is used to display a list of objects in an open window when the request is made from a context menu or dialog.

Since:
v5r1m0
See Also:
ObjectName

Field Summary
static java.lang.String ACTIVEJBQ_LIST
          The constant for displaying a list of active job queues in an open window.
static java.lang.String ACTIVEJOBS_LIST
          The constant for displaying a list of active jobs in an open window.
static java.lang.String ALLJBQ_LIST
          The constant for displaying a list of job queues in an open window.
static java.lang.String ALLUSERS_LIST
          The constant for displaying a list of users in an open window.
static java.lang.String CASERVERS_LIST
          The constant for displaying a list of Client Access servers in an open window.
static java.lang.String GROUPS_LIST
          The constant for displaying a list of user groups in an open window.
static java.lang.String JOBS_LIST
          The constant for displaying a list of jobs in an open window.
static java.lang.String MESSAGES_LIST
          The constant for displaying a list of messages in an open window.
static java.lang.String OUTPUT_LIST
          The constant for displaying a list of printer output in an open window.
static java.lang.String PRINTERS_LIST
          The constant for displaying a list of printers in an open window.
static java.lang.String SBS_LIST
          The constant for displaying a list of subsystems in an open window.
static java.lang.String SERVERJOBS_LIST
          The constant for displaying a list of server jobs (Java) in an open window.
static java.lang.String SJOBS_LIST
          The constant for displaying a list of server jobs in an open window.
static java.lang.String SYSTEMVALUE_LIST
          The constant for displaying a list of System Value categories in an open window.
static java.lang.String TCPSERVERS_LIST
          The constant for displaying a list of TCP/IP servers in an open window.
 
Constructor Summary
OpenWindowData(java.lang.String listType, ObjectName container)
          Constructs an OpenWindowData object using the specified List type
 
Method Summary
 boolean displayOpenWindow()
          Display the specified open window
 java.lang.String getListTitle()
          Gets the list title
 boolean getObjectSupplied()
          Gets the object supplied boolean
 java.lang.String[] getOpenWindowDisplayNames()
          Gets the names of the objects to be displayed in the open window
 boolean getOpenWindowInfo()
          Get the current open window info from the Navigator.
 ObjectName getSelectedObject()
          Gets the selected object
 java.lang.String getSelectedObjectName()
          Gets the selected object name
 java.lang.String getSelectedObjectType()
          Gets the selected object type
 java.lang.String getSelectedSystemName()
          Gets the selected object's system name
 void resetOpenWindowInfo()
          Reset the current open window information for this list type
 void setListTitle(java.lang.String title)
          Sets the open window title
 void setMCList(boolean bMC)
          Sets the boolean that indicates whether the open window being displayed is for a container that resides within Management Central
 void setObjectName(ObjectName obj)
          Sets the selected object name object
 void setObjectName(java.lang.String name)
          Sets the selected object name
 void setObjectSupplied(boolean objSupplied)
          Sets the boolean that indicates whether the open window information is being supplied via an ObjectType instance
 void setObjectType(java.lang.String type)
          Sets the selected object type
 void setOpenWindowDisplayNames(java.lang.String[] dspNames)
          Sets the desired names to be displayed in the open window
 void setSystemName(java.lang.String sysName)
          Sets the selected object's system name
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OUTPUT_LIST

public static final java.lang.String OUTPUT_LIST
The constant for displaying a list of printer output in an open window.
Since:
v5r1m0

MESSAGES_LIST

public static final java.lang.String MESSAGES_LIST
The constant for displaying a list of messages in an open window.
Since:
v5r1m0

PRINTERS_LIST

public static final java.lang.String PRINTERS_LIST
The constant for displaying a list of printers in an open window.
Since:
v5r1m0

JOBS_LIST

public static final java.lang.String JOBS_LIST
The constant for displaying a list of jobs in an open window.
Since:
v5r1m0

SJOBS_LIST

public static final java.lang.String SJOBS_LIST
The constant for displaying a list of server jobs in an open window.
Since:
v5r1m0

TCPSERVERS_LIST

public static final java.lang.String TCPSERVERS_LIST
The constant for displaying a list of TCP/IP servers in an open window.
Since:
v5r1m0

CASERVERS_LIST

public static final java.lang.String CASERVERS_LIST
The constant for displaying a list of Client Access servers in an open window.
Since:
v5r1m0

ALLUSERS_LIST

public static final java.lang.String ALLUSERS_LIST
The constant for displaying a list of users in an open window.
Since:
v5r1m0

GROUPS_LIST

public static final java.lang.String GROUPS_LIST
The constant for displaying a list of user groups in an open window.
Since:
v5r1m0

SBS_LIST

public static final java.lang.String SBS_LIST
The constant for displaying a list of subsystems in an open window.
Since:
v5r1m0

ALLJBQ_LIST

public static final java.lang.String ALLJBQ_LIST
The constant for displaying a list of job queues in an open window.
Since:
v5r1m0

ACTIVEJBQ_LIST

public static final java.lang.String ACTIVEJBQ_LIST
The constant for displaying a list of active job queues in an open window.
Since:
v5r1m0

ACTIVEJOBS_LIST

public static final java.lang.String ACTIVEJOBS_LIST
The constant for displaying a list of active jobs in an open window.
Since:
v5r1m0

SERVERJOBS_LIST

public static final java.lang.String SERVERJOBS_LIST
The constant for displaying a list of server jobs (Java) in an open window.
Since:
v5r1m0

SYSTEMVALUE_LIST

public static final java.lang.String SYSTEMVALUE_LIST
The constant for displaying a list of System Value categories in an open window.
Since:
v5r1m0
Constructor Detail

OpenWindowData

public OpenWindowData(java.lang.String listType,
                      ObjectName container)
Constructs an OpenWindowData object using the specified List type
Parameters:
listType - type of list to be displayed (see constants above)
container - an ObjectName that identifies the container for the list that is being opened
Since:
v5r1m0
Method Detail

setListTitle

public void setListTitle(java.lang.String title)
Sets the open window title
Parameters:
title - title to be displayed in open window (not including system)
Since:
v5r1m0

setObjectSupplied

public void setObjectSupplied(boolean objSupplied)
Sets the boolean that indicates whether the open window information is being supplied via an ObjectType instance
Parameters:
objSupplied - boolean that tells whether an ObjectType object is being supplied
Since:
v5r1m0

setMCList

public void setMCList(boolean bMC)
Sets the boolean that indicates whether the open window being displayed is for a container that resides within Management Central
Parameters:
bMC - boolean that tells whether the container resides within Management Central
Since:
v5r1m0

setObjectName

public void setObjectName(ObjectName obj)
                   throws ObjectNameException
Sets the selected object name object
Parameters:
obj - ObjectType object for which the open window is being requested
Throws:
ObjectNameException - if there is an error with the supplied ObjectName
Since:
v5r1m0
See Also:
ObjectName

setObjectName

public void setObjectName(java.lang.String name)
Sets the selected object name
Parameters:
name - object name that the open window was requested for
Since:
v5r1m0

setObjectType

public void setObjectType(java.lang.String type)
Sets the selected object type
Parameters:
type - object type of the item that the open window was requested for
Since:
v5r1m0

setSystemName

public void setSystemName(java.lang.String sysName)
Sets the selected object's system name
Parameters:
sysName - system name that the open window is for
Since:
v5r1m0

setOpenWindowDisplayNames

public void setOpenWindowDisplayNames(java.lang.String[] dspNames)
Sets the desired names to be displayed in the open window
Parameters:
dspNames - array of strings representing the names of objects to be displayed in the open window
Since:
v5r1m0

getListTitle

public java.lang.String getListTitle()
Gets the list title
Since:
v5r1m0

getObjectSupplied

public boolean getObjectSupplied()
Gets the object supplied boolean
Returns:
boolean indicating whether an ObjectName object was supplied
Since:
v5r1m0

getSelectedObject

public ObjectName getSelectedObject()
Gets the selected object
Returns:
the object that the open window was requested for
Since:
v5r1m0

getSelectedObjectName

public java.lang.String getSelectedObjectName()
Gets the selected object name
Returns:
object name that the open window was requested for
Since:
v5r1m0

getSelectedObjectType

public java.lang.String getSelectedObjectType()
Gets the selected object type
Returns:
object type that the open window was requested for
Since:
v5r1m0

getSelectedSystemName

public java.lang.String getSelectedSystemName()
Gets the selected object's system name
Returns:
system name that the open window was requested for
Since:
v5r1m0

getOpenWindowDisplayNames

public java.lang.String[] getOpenWindowDisplayNames()
Gets the names of the objects to be displayed in the open window
Returns:
string array of names to be displayed
Since:
v5r1m0

displayOpenWindow

public boolean displayOpenWindow()
Display the specified open window
Returns:
boolean indicating if display of open window was successfull
Since:
v5r1m0

getOpenWindowInfo

public boolean getOpenWindowInfo()
Get the current open window info from the Navigator. If the return value is true, you can then retrieve the desired open window data by calling the appropriate getOpenWindow...
Returns:
boolean indicating whether open window information was retrieved successfully
Since:
v5r1m0

resetOpenWindowInfo

public void resetOpenWindowInfo()
Reset the current open window information for this list type
Since:
v5r1m0