com.ibm.as400.opnav
Class ObjectName

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

public class ObjectName
extends java.lang.Object
implements java.io.Serializable

A data entity which represents a hierarchical object name on some UI platform. The format of an object name is opaque to client interface implementations. Gettor methods are provided which allow clients to extract relevant information, such as the name of the object's parent or the name of the system under which the object appears in the containment hierarchy.

Since:
v4r4m0
See Also:
ListManager, ActionsManager, DropTargetManager, Serialized Form

Field Summary
static int JAVA_CONSOLE
          THIS CONSTANT IS CURRENTLY NOT SUPPORTED
static int JAVA_SWING_CONSOLE
          THIS CONSTANT IS CURRENTLY NOT SUPPORTED
static int WINDOWS_CONSOLE
          THIS CONSTANT IS CURRENTLY NOT SUPPORTED
 
Method Summary
 int getConsoleType()
          THIS METHOD IS CURRENTLY NOT SUPPORTED Return the console type for this Object in the java framework
 java.lang.Object getContextInfo()
          THIS METHOD IS CURRENTLY NOT SUPPORTED Retrieve an object that was stored into the context of this ObjectName.
 java.lang.Object getContextInfo(java.lang.String key)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Retrieve an object that was stored into the context of this ObjectName.
 java.lang.String getDisplayName()
          Returns the display name.
 java.lang.String getDisplayPath()
          Returns the display path.
 java.awt.Frame getFrame()
          THIS METHOD IS CURRENTLY NOT SUPPORTED Will return the frame that this object resides in
 ListManager getListManager()
           
 java.lang.Object getListObject()
          Returns a cached list object.
 int getObjectIndex()
          Returns the object index.
 java.lang.String getObjectType()
          Returns the object type.
 ObjectName getParentFolder()
          Returns the parent folder.
 java.lang.String getParentFolderName()
          Returns the parent folder name.
 java.lang.String getParentFolderPath()
          Returns the parent folder path.
 java.lang.Object getPublicListObject()
          Returns a public cached list object.
 java.lang.String getSystemName()
          Returns the object's system name.
 java.lang.Object getSystemObject()
          Returns an AS400 system object.
 java.lang.Object getSystemObject(java.lang.String sessionName)
          Returns an AS400 system object.
static java.lang.Object getSystemObject(java.lang.String systemName, java.lang.String sessionName)
          Returns an AS400 system object.
 void setContextInfo(java.lang.Object info)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Save a user defined object into the context of this ObjectName.
 void setContextInfo(java.lang.String key, java.lang.Object info)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Save a user defined object into the context of this ObjectName.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

JAVA_CONSOLE

public static final int JAVA_CONSOLE
THIS CONSTANT IS CURRENTLY NOT SUPPORTED

JAVA_SWING_CONSOLE

public static final int JAVA_SWING_CONSOLE
THIS CONSTANT IS CURRENTLY NOT SUPPORTED

WINDOWS_CONSOLE

public static final int WINDOWS_CONSOLE
THIS CONSTANT IS CURRENTLY NOT SUPPORTED
Method Detail

getConsoleType

public int getConsoleType()
THIS METHOD IS CURRENTLY NOT SUPPORTED Return the console type for this Object in the java framework
Parameters:
none -  
Returns:
The console type, which is one of: WINDOWS_CONSOLE, JAVA_SWING_CONSOLE, or JAVA_CONSOLE
Since:
v5r1m0

getFrame

public java.awt.Frame getFrame()
THIS METHOD IS CURRENTLY NOT SUPPORTED Will return the frame that this object resides in
Parameters:
none -  
Returns:
the AWT Frame

getListManager

public ListManager getListManager()

setContextInfo

public void setContextInfo(java.lang.Object info)
THIS METHOD IS CURRENTLY NOT SUPPORTED Save a user defined object into the context of this ObjectName. This method allows you to save and later retrieve any object.
Parameters:
info - A user defined object that will be saved into the context of this ObjectName
See Also:
getContextInfo

setContextInfo

public void setContextInfo(java.lang.String key,
                           java.lang.Object info)
THIS METHOD IS CURRENTLY NOT SUPPORTED Save a user defined object into the context of this ObjectName. This method allows you to save and later retrieve any object.
Parameters:
key - The key assocated with the object
info - A user defined object that will be saved into the context of this ObjectName
See Also:
getContextInfo

getContextInfo

public java.lang.Object getContextInfo()
THIS METHOD IS CURRENTLY NOT SUPPORTED Retrieve an object that was stored into the context of this ObjectName. by the setContextInfo method If this ObjectName represents an item in a tree hierarchy this method will return the last object set in an ObjectName in the path from this item upto the root node of the tree For example, if a user set an Object into the root node of the tree, all lower level nodes will return the Object set in the root node.
Returns:
Object A user defined object that was be saved using the setContextInfo If no Object was ever set into this ObjectName then the Object set in a parent ObjectName will be returned. If no Object was ever set into any parent ObjectName, this method will return null
See Also:
setContextInfo

getContextInfo

public java.lang.Object getContextInfo(java.lang.String key)
THIS METHOD IS CURRENTLY NOT SUPPORTED Retrieve an object that was stored into the context of this ObjectName. by the setContextInfo method If this ObjectName represents an item in a tree hierarchy this method will return the last object set in an ObjectName in the path from this item upto the root node of the tree For example, if a user set an Object into the root node of the tree, all lower level nodes will return the Object set in the root node.
Parameters:
key - The key assocated with the object
Returns:
Object A user defined object that was be saved using the setContextInfo If no Object was ever set into this ObjectName then the Object set in a parent ObjectName will be returned. If no Object was ever set into any parent ObjectName, this method will return null
See Also:
setContextInfo

getDisplayName

public java.lang.String getDisplayName()
                                throws ObjectNameException
Returns the display name.
Returns:
The display name.
Throws:
ObjectNameException - if there is an error

getDisplayPath

public java.lang.String getDisplayPath()
                                throws ObjectNameException
Returns the display path.
Returns:
The display path.
Throws:
ObjectNameException - if there is an error

getListObject

public java.lang.Object getListObject()
                               throws ObjectNameException
Returns a cached list object. This method is called when another interface implementation requires access to the proxy object that represents a resource on the system being managed.
Returns:
The cached proxy object.
Throws:
ObjectNameException - if there is an error
Since:
v4r4m0
See Also:
ListManager

getParentFolder

public ObjectName getParentFolder()
                           throws ObjectNameException
Returns the parent folder.
Returns:
The ObjectName of the parent container.
Throws:
ObjectNameException - if there is an error

getParentFolderName

public java.lang.String getParentFolderName()
                                     throws ObjectNameException
Returns the parent folder name.
Returns:
The parent folder name.
Throws:
ObjectNameException - if there is an error

getParentFolderPath

public java.lang.String getParentFolderPath()
                                     throws ObjectNameException
Returns the parent folder path.
Returns:
The parent folder path.
Throws:
ObjectNameException - if there is an error

getObjectType

public java.lang.String getObjectType()
                               throws ObjectNameException
Returns the object type.
Returns:
The unique type string defined for this object type.
Throws:
ObjectNameException - if the object name format is not valid
Since:
v4r4m0

getObjectIndex

public int getObjectIndex()
                   throws ObjectNameException
Returns the object index.
Returns:
The zero-based index of the object in the list of system objects.
Throws:
ObjectNameException - if the object name format is not valid
Since:
v4r4m0

getSystemName

public java.lang.String getSystemName()
                               throws ObjectNameException
Returns the object's system name.
Returns:
The name of the system on which this object resides.
Throws:
ObjectNameException - if the object name format is not valid
Since:
v4r4m0

getSystemObject

public java.lang.Object getSystemObject()
                                 throws ObjectNameException
Returns an AS400 system object.
Returns:
The system object.
Throws:
ObjectNameException - if the object name format is not valid or there is an error

getSystemObject

public java.lang.Object getSystemObject(java.lang.String sessionName)
                                 throws ObjectNameException
Returns an AS400 system object.
Parameters:
sessionName - Identifies the session to use to connect to the AS/400 system. If null, an existing session will be used.
Returns:
The system object.
Throws:
ObjectNameException - if the object name format is not valid or there is an error

getSystemObject

public static java.lang.Object getSystemObject(java.lang.String systemName,
                                               java.lang.String sessionName)
                                        throws ObjectNameException
Returns an AS400 system object.
Parameters:
systemName - The name of the AS/400 system.
sessionName - Identifies the session to use to connect to the AS/400 system. If null, an existing session will be used.
Returns:
The system object.
Throws:
ObjectNameException - if the object name format is not valid or there is an error

getPublicListObject

public java.lang.Object getPublicListObject()
                                     throws ObjectNameException
Returns a public cached list object. This method is called when another interface implementation desires access to the public object that represents a resource on the system being managed. Public objects are objects that are documented for use by other components.
Returns:
The cached public object.
Throws:
ObjectNameException - if there is an error.
Since:
v5r1m0
See Also:
ListManager

toString

public java.lang.String toString()
Returns a string representation of the object.
Overrides:
toString in class java.lang.Object
Returns:
A string representation of the object.
Since:
v4r4m0