com.ibm.as400.opnav
Class ItemIdentifier

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

public class ItemIdentifier
extends java.lang.Object

A data entity which represents an item in a list of system objects. An ItemIdentifier uniquely identifies an item in a list relative to its parent container.

Since:
v4r4m0
See Also:
ListManager, ActionsManager, PropertiesManager, DropTargetManager

Constructor Summary
ItemIdentifier()
          Constructs an item identifier.
ItemIdentifier(int index)
          Constructs an item identifier having the specified index.
 
Method Summary
 java.lang.Object getContextInfo()
          THIS METHOD IS CURRENTLY NOT SUPPORTED Retrieve an object that was stored into the context of this ItemIdentifier.
 int getIndex()
          Returns the item index.
 java.lang.String getName()
          Returns the item name.
 java.lang.Object getOpNavItem()
          Retrieve an OpNavItem object that was stored into this ItemIdentifier.
 java.lang.String getType()
          Returns the item type.
 void setContextInfo(java.lang.Object info)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Save a user defined object into the context of this ItemIdentifier.
 void setIndex(int index)
          Sets the item index.
 void setName(java.lang.String name)
          Sets the item name.
 void setType(java.lang.String type)
          Sets the item type.
 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
 

Constructor Detail

ItemIdentifier

public ItemIdentifier()
Constructs an item identifier.
Since:
v4r4m0

ItemIdentifier

public ItemIdentifier(int index)
Constructs an item identifier having the specified index.
Parameters:
index - the zero-based index of the object in a list of system objects.
Since:
v4r4m0
Method Detail

getName

public java.lang.String getName()
Returns the item name.
Returns:
the name of the list object in a form suitable for displaying to the user.
Since:
v4r4m0
See Also:
setName(java.lang.String)

setName

public void setName(java.lang.String name)
Sets the item name.
Parameters:
name - the name of the list object in a form suitable for displaying to the user.
Since:
v4r4m0
See Also:
getName()

getType

public java.lang.String getType()
Returns the item type.
Returns:
the unique type string defined for objects of this type.
Since:
v4r4m0
See Also:
setType(java.lang.String)

setType

public void setType(java.lang.String type)
Sets the item type.
Parameters:
name - the unique type string defined for objects of this type.
Since:
v4r4m0
See Also:
getType()

getIndex

public int getIndex()
Returns the item index.
Returns:
the zero-based index of the object in a list of system objects.
Since:
v4r4m0
See Also:
setIndex(int)

setIndex

public void setIndex(int index)
Sets the item index.
Parameters:
index - the zero-based index of the object in a list of system objects.
Since:
v4r4m0
See Also:
getIndex()

setContextInfo

public void setContextInfo(java.lang.Object info)
THIS METHOD IS CURRENTLY NOT SUPPORTED Save a user defined object into the context of this ItemIdentifier. 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 itemIdentifier
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 ItemIdentifier. by the setContextInfo method If this ItemIdentifier represents an item in a tree hierarchy this method will return the last object set in an ItemIdentifier 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 ItemIdentifier then the Object set in a parent ItemIdentifier will be returned. If no Object was ever set into any parent ItemIdentifier, this method will return null
See Also:
setContextInfo

getOpNavItem

public java.lang.Object getOpNavItem()
Retrieve an OpNavItem object that was stored into this ItemIdentifier.
Returns:
An OpNavItem object if set, otherwise null
See Also:
setOpNavItem

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