All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.SystemValueGroup

java.lang.Object
   |
   +----com.ibm.as400.access.SystemValueGroup

public class SystemValueGroup
extends Object
implements Serializable
The SystemValueGroup class represents a user-defined collection of system values and network attributes. It isn't as much a container for SystemValue objects as it is a factory for generating collections of SystemValues having certain attributes.


Constructor Index

 o SystemValueGroup()
Constructs a SystemValueGroup object.
 o SystemValueGroup(AS400, String, String)
Constructs a SystemValueGroup object.
 o SystemValueGroup(AS400, String, String, int)
Constructs a SystemValueGroup object.
 o SystemValueGroup(AS400, String, String, String[])
Constructs a SystemValueGroup object.

Method Index

 o add(String)
Adds a system value to this group.
 o addPropertyChangeListener(PropertyChangeListener)
Adds a PropertyChangeListener.
 o addVetoableChangeListener(VetoableChangeListener)
Adds the VetoableChangeListener.
 o contains(String)
Determines if a system value is part of this group.
 o getDescription()
Returns the user-defined description for this group.
 o getGroup()
Returns newly-generated SystemValue objects representing the system values in this group.
 o getName()
Returns the user-defined name for this group.
 o getSystem()
Returns the system object for this group.
 o refresh(Vector)
Retrieves new values for the SystemValue objects in the Vector.
 o remove(String)
Removes a system value from this group.
 o removePropertyChangeListener(PropertyChangeListener)
Removes the PropertyChangeListener from the internal list.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes the VetoableChangeListener from the internal list.
 o setDescription(String)
Sets the user-defined group description for any SystemValue objects generated by this group.
 o setName(String)
Sets the user-defined group name for any SystemValue objects generated by this group.
 o setSystem(AS400)
Sets the system for any SystemValue objects generated by this group.

Constructors

 o SystemValueGroup
 public SystemValueGroup()
Constructs a SystemValueGroup object. The system, name, and description properties must be set before attempting a connection.

 o SystemValueGroup
 public SystemValueGroup(AS400 system,
                         String name,
                         String description)
Constructs a SystemValueGroup object. The group of system values is initialized to be empty.

Parameters:
system - The AS/400 that this group of system values references.
name - The user-defined group name for this group of system values.
description - The user-defined group description for this group of system values.
 o SystemValueGroup
 public SystemValueGroup(AS400 system,
                         String name,
                         String description,
                         String values[])
Constructs a SystemValueGroup object. The group of system values is initialized to contain values.

Parameters:
system - The AS/400 that this group of system values references.
name - The user-defined group name for this group of system values.
description - The user-defined group description for this group of system values.
values - The array of system values to be added to this group.
 o SystemValueGroup
 public SystemValueGroup(AS400 system,
                         String name,
                         String description,
                         int group)
Constructs a SystemValueGroup object. The group of system values is initialized to contain all of system values in the system-defined group. For example, specifying SystemValueList.GROUP_ALL for group would result in this group of system values being initialized to contain all system values and network attributes.

Parameters:
system - The AS/400 that this group of system values references.
name - The user-defined group name for this group of system values.
description - The user-defined group description for this group of system values.
group - The system value group constant indicating the set of system values to be added to this group.
See Also:
GROUP_ALL

Methods

 o add
 public void add(String value)
Adds a system value to this group. If value already exists in this group, then it is ignored. If value is not a valid system value name, an exception is thrown.

Parameters:
value - The system value to be added to this group.
 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener. The specified PropertyChangeListener's propertyChange method will be called each time the value of any bound property is changed.

Parameters:
listener - The PropertyChangeListener.
See Also:
removePropertyChangeListener
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds the VetoableChangeListener. The specified VetoableChangeListener's vetoableChange method will be called each time the value of any constrained property is changed.

Parameters:
listener - The VetoableChangeListener.
See Also:
removeVetoableChangeListener
 o contains
 public boolean contains(String value)
Determines if a system value is part of this group.

Parameters:
value - The system value in question.
Returns:
Returns true if the system value is part of this group; false otherwise.
 o getDescription
 public String getDescription()
Returns the user-defined description for this group.

Returns:
The group description.
 o getGroup
 public Vector getGroup() throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnknownHostException
Returns newly-generated SystemValue objects representing the system values in this group. The objects in the Vector are sorted by system value name.

Returns:
A Vector of SystemValue objects.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o getName
 public String getName()
Returns the user-defined name for this group.

Returns:
The group name.
 o getSystem
 public AS400 getSystem()
Returns the system object for this group.

Returns:
The AS400 system object.
 o refresh
 public static void refresh(Vector values) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnknownHostException
Retrieves new values for the SystemValue objects in the Vector. The SystemValue objects in values have their values refreshed from their respective systems. This method does not create new SystemValue objects; rather, it refreshes all SystemValue objects at once for a given system, which is more efficient than calling clear() on each SystemValue. All objects in values must be SystemValue objects.

Parameters:
values - The group of SystemValue objects to be refreshed.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnknownHostException
If the AS/400 system cannot be located.
See Also:
clear
 o remove
 public boolean remove(String value)
Removes a system value from this group.

Parameters:
value - The system value to be removed from this group.
Returns:
Returns true if the system value was successfully removed; false otherwise.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes the PropertyChangeListener from the internal list. If the PropertyChangeListener is not on the list, nothing is done.

Parameters:
listener - The PropertyChangeListener.
See Also:
addPropertyChangeListener
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes the VetoableChangeListener from the internal list. If the VetoableChangeListener is not on the list, nothing is done.

Parameters:
listener - The VetoableChangeListener.
See Also:
addVetoableChangeListener
 o setDescription
 public void setDescription(String description) throws PropertyVetoException
Sets the user-defined group description for any SystemValue objects generated by this group.

Parameters:
description - The group description.
Throws: PropertyVetoException
If the change is vetoed.
 o setName
 public void setName(String name) throws PropertyVetoException
Sets the user-defined group name for any SystemValue objects generated by this group.

Parameters:
name - The group name.
Throws: PropertyVetoException
If the change is vetoed.
 o setSystem
 public void setSystem(AS400 system) throws PropertyVetoException
Sets the system for any SystemValue objects generated by this group.

Parameters:
system - The AS400 system object.
Throws: PropertyVetoException
If the change is vetoed.

All Packages  Class Hierarchy  This Package  Previous  Next  Index