VUserList

java.lang.Object
- com.ibm.as400.vaccess.VUserList

All Implemented Interfaces:

VNode, VObject, java.io.Serializable, javax.swing.tree.TreeNode

Deprecated.
Use Java Swing instead, along with the classes in package com.ibm.as400.access
```
public class VUserList
extends java.lang.Object
implements VNode, java.io.Serializable
```
The VUserList class defines the representation of a user list on a system for use in various models and panes in this package. You must explicitly call load() to load the information from the system.
Most errors are reported as ErrorEvents rather than throwing exceptions. Users should listen for ErrorEvents in order to diagnose and recover from error conditions.
VUserList objects generate the following events:
- ErrorEvent
- PropertyChangeEvent
- VObjectEvent
- WorkingEvent
See Also:
Serialized Form

Field Summary
- Fields inherited from interface com.ibm.as400.vaccess.VObject
  DESCRIPTION_PROPERTY, NAME_PROPERTY

Constructor Summary

Constructors
Constructor and Description
`VUserList()` Deprecated. Constructs a VUserList object.
`VUserList(AS400 system)` Deprecated. Constructs a VUserList object.
`VUserList(UserList userList, java.lang.String listName)` Deprecated. Constructs a VUserList object.
`VUserList(VNode parent, AS400 system)` Deprecated. Constructs a VUserList object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addErrorListener(ErrorListener listener)` Deprecated. Adds a listener to be notified when an error occurs.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Deprecated. Adds a listener to be notified when the value of any bound property changes.
`void`	`addVetoableChangeListener(java.beans.VetoableChangeListener listener)` Deprecated. Adds a listener to be notified when the value of any constrained property changes.
`void`	`addVObjectListener(VObjectListener listener)` Deprecated. Adds a listener to be notified when a VObject is changed, created, or deleted.
`void`	`addWorkingListener(WorkingListener listener)` Deprecated. Adds a listener to be notified when work starts and stops on potentially long-running operations.
`java.util.Enumeration`	`children()` Deprecated. Returns the children of the node.
`VAction[]`	`getActions()` Deprecated. Returns the list of actions that can be performed.
`boolean`	`getAllowsChildren()` Deprecated. Indiciates if the node allows children.
`javax.swing.tree.TreeNode`	`getChildAt(int index)` Deprecated. Returns the child node at the specified index.
`int`	`getChildCount()` Deprecated. Returns the number of children.
`VAction`	`getDefaultAction()` Deprecated. Returns the default action.
`VObject`	`getDetailsChildAt(int index)` Deprecated. Returns the child for the details at the specified index.
`int`	`getDetailsChildCount()` Deprecated. Returns the number of children for the details.
`javax.swing.table.TableColumnModel`	`getDetailsColumnModel()` Deprecated. Returns the table column model to use in the details when representing the children.
`int`	`getDetailsIndex(VObject detailsChild)` Deprecated. Returns the index of the specified child for the details.
`java.lang.String`	`getGroupInfo()` Deprecated. Returns the group information.
`javax.swing.Icon`	`getIcon(int size, boolean open)` Deprecated. Returns the icon.
`int`	`getIndex(javax.swing.tree.TreeNode child)` Deprecated. Returns the index of the specified child.
`javax.swing.tree.TreeNode`	`getParent()` Deprecated. Returns the parent node.
`VPropertiesPane`	`getPropertiesPane()` Deprecated. Returns the properties pane.
`java.lang.Object`	`getPropertyValue(java.lang.Object propertyIdentifier)` Deprecated. Returns a property value.
`AS400`	`getSystem()` Deprecated. Returns the system from which the user will be retrieved.
`java.lang.String`	`getText()` Deprecated. Returns the description text.
`java.lang.String`	`getUserInfo()` Deprecated. Returns the user information.
`boolean`	`isLeaf()` Deprecated. Indicates if the node is a leaf.
`boolean`	`isSortable()` Deprecated. Indicates if the details children are sortable.
`void`	`load()` Deprecated. Loads information about the object from the system.
`void`	`removeErrorListener(ErrorListener listener)` Deprecated. Removes an error listener.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Deprecated. Removes a property change listener.
`void`	`removeVetoableChangeListener(java.beans.VetoableChangeListener listener)` Deprecated. Removes a vetoable change listener.
`void`	`removeVObjectListener(VObjectListener listener)` Deprecated. Removes a VObjectListener.
`void`	`removeWorkingListener(WorkingListener listener)` Deprecated. Removes a working listener.
`void`	`setGroupInfo(java.lang.String groupInfo)` Deprecated. Sets the group information.
`void`	`setSystem(AS400 system)` Deprecated. Sets the system in which the user information resides.
`void`	`setUserInfo(java.lang.String userInfo)` Deprecated. Sets the user information.
`void`	`sortDetailsChildren(java.lang.Object[] propertyIdentifiers, boolean[] orders)` Deprecated. Sorts the children for the details.
`java.lang.String`	`toString()` Deprecated. Returns the string representation of the description.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VUserList
```
public VUserList()
```
    Deprecated.
    
    Constructs a VUserList object.
  - VUserList
```
public VUserList(AS400 system)
```
    Deprecated.
    
    Constructs a VUserList object.
    
    Parameters:
    system - The system from which the user will be retrieved.
  - VUserList
```
public VUserList(UserList userList,
         java.lang.String listName)
```
    Deprecated.
    
    Constructs a VUserList object.
    
    Parameters:
    userList - The UserList object.
    listName - The name of the user list.
  - VUserList
```
public VUserList(VNode parent,
         AS400 system)
```
    Deprecated.
    
    Constructs a VUserList object.
    
    Parameters:
    parent - The parent.
    system - The system from which the user will be retrieved..
- Method Detail
  - addErrorListener
```
public void addErrorListener(ErrorListener listener)
```
    Deprecated.
    
    Adds a listener to be notified when an error occurs.
    
    Specified by:
    
    addErrorListener in interface VObject
    
    Parameters:
    listener - The listener.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Deprecated.
    
    Adds a listener to be notified when the value of any bound property changes.
    
    Parameters:
    listener - The listener.
  - addVetoableChangeListener
```
public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
```
    Deprecated.
    
    Adds a listener to be notified when the value of any constrained property changes.
    
    Parameters:
    listener - The listener.
  - addVObjectListener
```
public void addVObjectListener(VObjectListener listener)
```
    Deprecated.
    
    Adds a listener to be notified when a VObject is changed, created, or deleted.
    
    Specified by:
    
    addVObjectListener in interface VObject
    
    Parameters:
    listener - The listener.
  - addWorkingListener
```
public void addWorkingListener(WorkingListener listener)
```
    Deprecated.
    
    Adds a listener to be notified when work starts and stops on potentially long-running operations.
    
    Specified by:
    
    addWorkingListener in interface VObject
    
    Parameters:
    listener - The listener.
  - children
```
public java.util.Enumeration children()
```
    Deprecated.
    
    Returns the children of the node.
    
    Specified by:
    
    children in interface javax.swing.tree.TreeNode
    
    Returns:
    The children.
  - getActions
```
public VAction[] getActions()
```
    Deprecated.
    
    Returns the list of actions that can be performed.
    
    Specified by:
    
    getActions in interface VObject
    
    Returns:
    Always null. There are no actions.
  - getAllowsChildren
```
public boolean getAllowsChildren()
```
    Deprecated.
    
    Indiciates if the node allows children.
    
    Specified by:
    
    getAllowsChildren in interface javax.swing.tree.TreeNode
    
    Returns:
    Always false.
  - getChildAt
```
public javax.swing.tree.TreeNode getChildAt(int index)
```
    Deprecated.
    
    Returns the child node at the specified index.
    
    Specified by:
    
    getChildAt in interface javax.swing.tree.TreeNode
    
    Parameters:
    index - The index.
    
    Returns:
    Always null.
  - getChildCount
```
public int getChildCount()
```
    Deprecated.
    
    Returns the number of children.
    
    Specified by:
    
    getChildCount in interface javax.swing.tree.TreeNode
    
    Returns:
    Always 0.
  - getDefaultAction
```
public VAction getDefaultAction()
```
    Deprecated.
    
    Returns the default action.
    
    Specified by:
    
    getDefaultAction in interface VObject
    
    Returns:
    Always null. There is no default action.
  - getDetailsChildAt
```
public VObject getDetailsChildAt(int index)
```
    Deprecated.
    
    Returns the child for the details at the specified index.
    
    Specified by:
    
    getDetailsChildAt in interface VNode
    
    Parameters:
    index - The index.
    
    Returns:
    The child, or null if the index is not valid.
  - getDetailsChildCount
```
public int getDetailsChildCount()
```
    Deprecated.
    
    Returns the number of children for the details.
    
    Specified by:
    
    getDetailsChildCount in interface VNode
    
    Returns:
    The number of children for the details.
  - getDetailsColumnModel
```
public javax.swing.table.TableColumnModel getDetailsColumnModel()
```
    Deprecated.
    
    Returns the table column model to use in the details when representing the children. This column model describes the details values for the children.
    
    Specified by:
    
    getDetailsColumnModel in interface VNode
    
    Returns:
    The details column model.
    See Also:
    VObject.getPropertyValue(java.lang.Object)
  - getDetailsIndex
```
public int getDetailsIndex(VObject detailsChild)
```
    Deprecated.
    
    Returns the index of the specified child for the details.
    
    Specified by:
    
    getDetailsIndex in interface VNode
    
    Parameters:
    detailsChild - The details child.
    
    Returns:
    The index, or -1 if the child is not found in the details.
  - getGroupInfo
```
public java.lang.String getGroupInfo()
```
    Deprecated.
    
    Returns the group information.
    
    Returns:
    The group information.
    See Also:
    UserList.getGroupInfo()
  - getIcon
```
public javax.swing.Icon getIcon(int size,
                       boolean open)
```
    Deprecated.
    
    Returns the icon.
    
    Specified by:
    
    getIcon in interface VObject
    
    Parameters:
    size - The icon size, either 16 or 32. If any other value is given, then return a default.
    open - This parameter has no effect.
    
    Returns:
    The icon.
  - getIndex
```
public int getIndex(javax.swing.tree.TreeNode child)
```
    Deprecated.
    
    Returns the index of the specified child.
    
    Specified by:
    
    getIndex in interface javax.swing.tree.TreeNode
    
    Parameters:
    child - The child.
    
    Returns:
    Always -1.
  - getParent
```
public javax.swing.tree.TreeNode getParent()
```
    Deprecated.
    
    Returns the parent node.
    
    Specified by:
    
    getParent in interface javax.swing.tree.TreeNode
    
    Returns:
    The parent node, or null if there is no parent.
  - getPropertiesPane
```
public VPropertiesPane getPropertiesPane()
```
    Deprecated.
    
    Returns the properties pane.
    
    Specified by:
    
    getPropertiesPane in interface VObject
    
    Returns:
    The properties pane.
  - getPropertyValue
```
public java.lang.Object getPropertyValue(java.lang.Object propertyIdentifier)
```
    Deprecated.
    
    Returns a property value.
    
    Specified by:
    
    getPropertyValue in interface VObject
    
    Parameters:
    propertyIdentifier - The property identifier. The choices are NAME_PROPERTY and DESCRIPTION_PROPERTY.
    
    Returns:
    The property value, or null if the property identifier is not recognized.
  - getSystem
```
public AS400 getSystem()
```
    Deprecated.
    
    Returns the system from which the user will be retrieved.
    
    Returns:
    The system from which the user will be retrieved.
  - getText
```
public java.lang.String getText()
```
    Deprecated.
    
    Returns the description text.
    
    Specified by:
    
    getText in interface VObject
    
    Returns:
    The description text.
  - getUserInfo
```
public java.lang.String getUserInfo()
```
    Deprecated.
    
    Returns the user information.
    
    Returns:
    The user information.
    See Also:
    UserList.getUserInfo()
  - isLeaf
```
public boolean isLeaf()
```
    Deprecated.
    
    Indicates if the node is a leaf.
    
    Specified by:
    
    isLeaf in interface javax.swing.tree.TreeNode
    
    Returns:
    Always true.
  - isSortable
```
public boolean isSortable()
```
    Deprecated.
    
    Indicates if the details children are sortable.
    
    Specified by:
    
    isSortable in interface VNode
    
    Returns:
    Always false.
  - load
```
public void load()
```
    Deprecated.
    
    Loads information about the object from the system.
    
    Specified by:
    
    load in interface VObject
  - removeErrorListener
```
public void removeErrorListener(ErrorListener listener)
```
    Deprecated.
    
    Removes an error listener.
    
    Specified by:
    
    removeErrorListener in interface VObject
    
    Parameters:
    listener - The listener.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Deprecated.
    
    Removes a property change listener.
    
    Parameters:
    listener - The listener.
  - removeVetoableChangeListener
```
public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
```
    Deprecated.
    
    Removes a vetoable change listener.
    
    Parameters:
    listener - The listener.
  - removeVObjectListener
```
public void removeVObjectListener(VObjectListener listener)
```
    Deprecated.
    
    Removes a VObjectListener.
    
    Specified by:
    
    removeVObjectListener in interface VObject
    
    Parameters:
    listener - The listener.
  - removeWorkingListener
```
public void removeWorkingListener(WorkingListener listener)
```
    Deprecated.
    
    Removes a working listener.
    
    Specified by:
    
    removeWorkingListener in interface VObject
    
    Parameters:
    listener - The listener.
  - setGroupInfo
```
public void setGroupInfo(java.lang.String groupInfo)
                  throws java.beans.PropertyVetoException
```
    Deprecated.
    
    Sets the group information. The default is UserList.NONE.
    
    Parameters:
    groupInfo - The group information, either a group name, UserList.NOGROUP or UserList.NONE.
    
    Throws:
    
    java.beans.PropertyVetoException - If the change is vetoed.
    See Also:
    UserList.setGroupInfo(java.lang.String)
  - setSystem
```
public void setSystem(AS400 system)
               throws java.beans.PropertyVetoException
```
    Deprecated.
    
    Sets the system in which the user information resides.
    
    Parameters:
    system - The system in which the user information resides.
    
    Throws:
    
    java.beans.PropertyVetoException - If the change is vetoed.
  - setUserInfo
```
public void setUserInfo(java.lang.String userInfo)
                 throws java.beans.PropertyVetoException
```
    Deprecated.
    
    Sets the user information. The default is UserList.ALL.
    Parameters:
    userInfo - The user information, one of:
    
    UserList.ALL
    UserList.USER
    UserList.GROUP
    UserList.MEMBER
    Throws:
    
    java.beans.PropertyVetoException - If the change is vetoed.
    See Also:
    UserList.setUserInfo(java.lang.String)
  - sortDetailsChildren
```
public void sortDetailsChildren(java.lang.Object[] propertyIdentifiers,
                       boolean[] orders)
```
    Deprecated.
    
    Sorts the children for the details. Since sorting is not supported, this method does nothing.
    
    Specified by:
    
    sortDetailsChildren in interface VNode
    
    Parameters:
    propertyIdentifiers - The property identifiers.
    orders - The sort orders for each property identifier. true for ascending order; false for descending order.
  - toString
```
public java.lang.String toString()
```
    Deprecated.
    
    Returns the string representation of the description.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The string representation of the description.

Fields inherited from interface com.ibm.as400.vaccess.VObject

Methods inherited from class java.lang.Object

VUserList

VUserList

VUserList

VUserList

addErrorListener

addPropertyChangeListener

addVetoableChangeListener

addVObjectListener

addWorkingListener

children

getActions

getAllowsChildren

getChildAt

getChildCount

getDefaultAction

getDetailsChildAt

getDetailsChildCount

getDetailsColumnModel

getDetailsIndex

getGroupInfo

getIcon

getIndex

getParent

getPropertiesPane

getPropertyValue

getSystem

getText

getUserInfo

isLeaf

isSortable

load

removeErrorListener

removePropertyChangeListener

removeVetoableChangeListener

removeVObjectListener

removeWorkingListener

setGroupInfo

setSystem

setUserInfo

sortDetailsChildren

toString