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.
The AS/400 must be at V3R7 or later.
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:
- ErrorEvent
- PropertyChangeEvent
- VObjectEvent
- WorkingEvent
-
VUserList()
- Constructs a VUserList object.
-
VUserList(AS400)
- Constructs a VUserList object.
-
VUserList(VNode, AS400)
- Constructs a VUserList object.
-
addErrorListener(ErrorListener)
- Adds a listener to be notified when an error occurs.
-
addPropertyChangeListener(PropertyChangeListener)
- Adds a listener to be notified when the value of any
bound property changes.
-
addVetoableChangeListener(VetoableChangeListener)
- Adds a listener to be notified when the value of any
constrained property changes.
-
addVObjectListener(VObjectListener)
- Adds a listener to be notified when a VObject is changed,
created, or deleted.
-
addWorkingListener(WorkingListener)
- Adds a listener to be notified when work starts and stops
on potentially long-running operations.
-
children()
- Returns the children of the node.
-
getActions()
- Returns the list of actions that can be performed.
-
getAllowsChildren()
- Indiciates if the node allows children.
-
getChildAt(int)
- Returns the child node at the specified index.
-
getChildCount()
- Returns the number of children.
-
getDefaultAction()
- Returns the default action.
-
getDetailsChildAt(int)
- Returns the child for the details at the specified index.
-
getDetailsChildCount()
- Returns the number of children for the details.
-
getDetailsColumnModel()
- Returns the table column model to use in the details
when representing the children.
-
getDetailsIndex(VObject)
- Returns the index of the specified child for the details.
-
getGroupInfo()
- Returns the group information.
-
getIcon(int, boolean)
- Returns the icon.
-
getIndex(TreeNode)
- Returns the index of the specified child.
-
getParent()
- Returns the parent node.
-
getPropertiesPane()
- Returns the properties pane.
-
getPropertyValue(Object)
- Returns a property value.
-
getSystem()
- Returns the AS/400 system from which the user will be retrieved.
-
getText()
- Returns the description text.
-
getUserInfo()
- Returns the user information.
-
isLeaf()
- Indicates if the node is a leaf.
-
isSortable()
- Indicates if the details children are sortable.
-
load()
- Loads information about the object from the AS/400.
-
removeErrorListener(ErrorListener)
- Removes an error listener.
-
removePropertyChangeListener(PropertyChangeListener)
- Removes a property change listener.
-
removeVetoableChangeListener(VetoableChangeListener)
- Removes a vetoable change listener.
-
removeVObjectListener(VObjectListener)
- Removes a VObjectListener.
-
removeWorkingListener(WorkingListener)
- Removes a working listener.
-
setGroupInfo(String)
- Sets the group information.
-
setSystem(AS400)
- Sets the AS/400 system from which the user will be retrieved.
-
setUserInfo(String)
- Sets the user information.
-
sortDetailsChildren(Object[], boolean[])
- Sorts the children for the details.
-
toString()
- Returns the string representation of the description.
VUserList
public VUserList()
- Constructs a VUserList object.
VUserList
public VUserList(AS400 system)
- Constructs a VUserList object.
- Parameters:
- system - The AS/400 system from which the user will be retrieved.
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..
addErrorListener
public void addErrorListener(ErrorListener listener)
- Adds a listener to be notified when an error occurs.
- Parameters:
- listener - The listener.
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
- Adds a listener to be notified when the value of any
bound property changes.
- Parameters:
- listener - The listener.
addVetoableChangeListener
public void addVetoableChangeListener(VetoableChangeListener listener)
- Adds a listener to be notified when the value of any
constrained property changes.
- Parameters:
- listener - The listener.
addVObjectListener
public void addVObjectListener(VObjectListener listener)
- Adds a listener to be notified when a VObject is changed,
created, or deleted.
- Parameters:
- listener - The listener.
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.
children
public Enumeration children()
- Returns the children of the node.
- Returns:
- The children.
getActions
public VAction[] getActions()
- Returns the list of actions that can be performed.
- Returns:
- Always null. There are no actions.
getAllowsChildren
public boolean getAllowsChildren()
- Indiciates if the node allows children.
- Returns:
- Always false.
getChildAt
public TreeNode getChildAt(int index)
- Returns the child node at the specified index.
- Parameters:
- index - The index.
- Returns:
- Always null.
getChildCount
public synchronized int getChildCount()
- Returns the number of children.
- Returns:
- Always 0.
getDefaultAction
public VAction getDefaultAction()
- Returns the default action.
- Returns:
- Always null. There is no default action.
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.
getDetailsChildCount
public synchronized int getDetailsChildCount()
- Returns the number of children for the details.
- Returns:
- The number of children for the details.
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.
getDetailsIndex
public synchronized 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.
getGroupInfo
public String getGroupInfo()
- Returns the group information.
- Returns:
- The group information.
- See Also:
- getGroupInfo
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.
getIndex
public synchronized int getIndex(TreeNode child)
- Returns the index of the specified child.
- Parameters:
- child - The child.
- Returns:
- Always -1.
getParent
public TreeNode getParent()
- Returns the parent node.
- Returns:
- The parent node, or null if there is no parent.
getPropertiesPane
public VPropertiesPane getPropertiesPane()
- Returns the properties pane.
- Returns:
- The properties pane.
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.
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
getText
public String getText()
- Returns the description text.
- Returns:
- The description text.
getUserInfo
public String getUserInfo()
- Returns the user information.
- Returns:
- The user information.
- See Also:
- getUserInfo
isLeaf
public boolean isLeaf()
- Indicates if the node is a leaf.
- Returns:
- Always true.
isSortable
public boolean isSortable()
- Indicates if the details children are sortable.
- Returns:
- Always false.
load
public void load()
- Loads information about the object from the AS/400.
removeErrorListener
public void removeErrorListener(ErrorListener listener)
- Removes an error listener.
- Parameters:
- listener - The listener.
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
- Removes a property change listener.
- Parameters:
- listener - The listener.
removeVetoableChangeListener
public void removeVetoableChangeListener(VetoableChangeListener listener)
- Removes a vetoable change listener.
- Parameters:
- listener - The listener.
removeVObjectListener
public void removeVObjectListener(VObjectListener listener)
- Removes a VObjectListener.
- Parameters:
- listener - The listener.
removeWorkingListener
public void removeWorkingListener(WorkingListener listener)
- Removes a working listener.
- Parameters:
- listener - The listener.
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
setSystem
public void setSystem(AS400 system) throws PropertyVetoException
- Sets the AS/400 system from which the user will be retrieved.
- Parameters:
- system - The AS/400 system from which the user will be retrieved.
- Throws: PropertyVetoException
- If the change is vetoed.
- See Also:
- setSystem
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
sortDetailsChildren
public synchronized 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.
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