All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.vaccess.VUserList

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

public class VUserList
extends Object
implements VNode, Serializable
The VUserList class defines the representation of a user list on an AS/400 for use in various models and panes in this package. You must explicitly call load() to load the information from the AS/400.

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:


Constructor Index

 o VUserList()
Constructs a VUserList object.
 o VUserList(AS400)
Constructs a VUserList object.
 o VUserList(UserList, String)
Constructs a VUserList object.
 o VUserList(VNode, AS400)
Constructs a VUserList object.

Method Index

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

Constructors

 o VUserList
 public VUserList()
Constructs a VUserList object.

 o VUserList
 public VUserList(AS400 system)
Constructs a VUserList object.

Parameters:
system - The AS/400 system from which the user will be retrieved.
 o VUserList
 public VUserList(UserList userList,
                  String listName)
Constructs a VUserList object.

Parameters:
userList - The UserList object.
listName - The name of the user list.
 o VUserList
 public VUserList(VNode parent,
                  AS400 system)
Constructs a VUserList object.

Parameters:
parent - The parent.
system - The AS/400 system from which the user will be retrieved..

Methods

 o addErrorListener
 public void addErrorListener(ErrorListener listener)
Adds a listener to be notified when an error occurs.

Parameters:
listener - The listener.
 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes.

Parameters:
listener - The listener.
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes.

Parameters:
listener - The listener.
 o addVObjectListener
 public void addVObjectListener(VObjectListener listener)
Adds a listener to be notified when a VObject is changed, created, or deleted.

Parameters:
listener - The listener.
 o addWorkingListener
 public void addWorkingListener(WorkingListener listener)
Adds a listener to be notified when work starts and stops on potentially long-running operations.

Parameters:
listener - The listener.
 o children
 public Enumeration children()
Returns the children of the node.

Returns:
The children.
 o getActions
 public VAction[] getActions()
Returns the list of actions that can be performed.

Returns:
Always null. There are no actions.
 o getAllowsChildren
 public boolean getAllowsChildren()
Indiciates if the node allows children.

Returns:
Always false.
 o getChildAt
 public TreeNode getChildAt(int index)
Returns the child node at the specified index.

Parameters:
index - The index.
Returns:
Always null.
 o getChildCount
 public int getChildCount()
Returns the number of children.

Returns:
Always 0.
 o getDefaultAction
 public VAction getDefaultAction()
Returns the default action.

Returns:
Always null. There is no default action.
 o getDetailsChildAt
 public VObject getDetailsChildAt(int index)
Returns the child for the details at the specified index.

Parameters:
index - The index.
Returns:
The child, or null if the index is not valid.
 o getDetailsChildCount
 public int getDetailsChildCount()
Returns the number of children for the details.

Returns:
The number of children for the details.
 o getDetailsColumnModel
 public TableColumnModel getDetailsColumnModel()
Returns the table column model to use in the details when representing the children. This column model describes the details values for the children.

Returns:
The details column model.
 o getDetailsIndex
 public int getDetailsIndex(VObject detailsChild)
Returns the index of the specified child for the details.

Parameters:
detailsChild - The details child.
Returns:
The index, or -1 if the child is not found in the details.
 o getGroupInfo
 public String getGroupInfo()
Returns the group information.

Returns:
The group information.
See Also:
getGroupInfo
 o getIcon
 public Icon getIcon(int size,
                     boolean open)
Returns the icon.

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.
 o getIndex
 public int getIndex(TreeNode child)
Returns the index of the specified child.

Parameters:
child - The child.
Returns:
Always -1.
 o getParent
 public TreeNode getParent()
Returns the parent node.

Returns:
The parent node, or null if there is no parent.
 o getPropertiesPane
 public VPropertiesPane getPropertiesPane()
Returns the properties pane.

Returns:
The properties pane.
 o getPropertyValue
 public Object getPropertyValue(Object propertyIdentifier)
Returns a property value.

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.
 o getSystem
 public AS400 getSystem()
Returns the AS/400 system from which the user will be retrieved.

Returns:
The AS/400 system from which the user will be retrieved.
See Also:
getSystem
 o getText
 public String getText()
Returns the description text.

Returns:
The description text.
 o getUserInfo
 public String getUserInfo()
Returns the user information.

Returns:
The user information.
See Also:
getUserInfo
 o isLeaf
 public boolean isLeaf()
Indicates if the node is a leaf.

Returns:
Always true.
 o isSortable
 public boolean isSortable()
Indicates if the details children are sortable.

Returns:
Always false.
 o load
 public void load()
Loads information about the object from the AS/400.

 o removeErrorListener
 public void removeErrorListener(ErrorListener listener)
Removes an error listener.

Parameters:
listener - The listener.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a property change listener.

Parameters:
listener - The listener.
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes a vetoable change listener.

Parameters:
listener - The listener.
 o removeVObjectListener
 public void removeVObjectListener(VObjectListener listener)
Removes a VObjectListener.

Parameters:
listener - The listener.
 o removeWorkingListener
 public void removeWorkingListener(WorkingListener listener)
Removes a working listener.

Parameters:
listener - The listener.
 o setGroupInfo
 public void setGroupInfo(String groupInfo) throws PropertyVetoException
Sets the group information. The default is UserList.NONE.

Parameters:
groupInfo - The group information, either a group name, UserList.NOGROUP or UserList.NONE.
Throws: PropertyVetoException
If the change is vetoed.
See Also:
setGroupInfo
 o setSystem
 public void setSystem(AS400 system) throws PropertyVetoException
Sets the AS/400 system in which the user information resides.

Parameters:
system - The AS/400 system in which the user information resides.
Throws: PropertyVetoException
If the change is vetoed.
See Also:
setSystem
 o setUserInfo
 public void setUserInfo(String userInfo) throws PropertyVetoException
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: PropertyVetoException
If the change is vetoed.
See Also:
setUserInfo
 o sortDetailsChildren
 public void sortDetailsChildren(Object propertyIdentifiers[],
                                 boolean orders[])
Sorts the children for the details. Sorting is not supported.

Parameters:
propertyIdentifiers - The property identifiers.
orders - The sort orders for each property identifier. true for ascending order; false for descending order.
 o toString
 public String toString()
Returns the string representation of the description.

Returns:
The string representation of the description.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index