com.ibm.as400.access
Class SystemValueList

java.lang.Object
  com.ibm.as400.access.SystemValueList

All Implemented Interfaces:

Serializable

public class SystemValueList
extends Object
implements Serializable

Provided methods for retrieving information about lists of System Values.

See Also:

SystemValue, Serialized Form

Field Summary

static int	GROUP_ALC Constant indicating the system value's group is *ALC (Allocation).
static int	GROUP_ALL Constant indicating the system value's group is *ALL (All).
static int	GROUP_DATTIM Constant indicating the system value's group is *DATTIM (Date and Time).
static int	GROUP_EDT Constant indicating the system value's group is *EDT (Editing).
static int	GROUP_LIBL Constant indicating the system value's group is *LIBL (Library List).
static int	GROUP_MSG Constant indicating the system value's group is *MSG (Message and Logging).
static int	GROUP_NET Constant indicating the system value's group is *NET (Net Attribute).
static int	GROUP_SEC Constant indicating the system value's group is *SEC (Security).
static int	GROUP_STG Constant indicating the system value's group is *STG (Storage).
static int	GROUP_SYSCTL Constant indicating the system value's group is *SYSCTL (System control).
static int	TYPE_ARRAY Constant indicating the returned system value type is String[].
static int	TYPE_DATE Constant indicating the returned system value type is Date.
static int	TYPE_DECIMAL Constant indicating the returned system value type is BigDecimal.
static int	TYPE_INTEGER Constant indicating the returned system value type is Integer.
static int	TYPE_STRING Constant indicating the returned system value type is String.

Constructor Summary

SystemValueList()
Constructs a SystemValueList object.

SystemValueList(AS400 system)
Constructs a SystemValueList object.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener.
void	addVetoableChangeListener(VetoableChangeListener listener) Adds a VetoableChangeListener.
Vector	getGroup(int group) Returns a set of SystemValue objects.
static int	getGroupCount() Returns the total number of possible groups.
static String	getGroupDescription(int group) Returns the description for the specified system value group.
static String	getGroupDescription(int group, Locale locale) Returns the description for the specified system value group.
static String	getGroupName(int group) Returns the name of the specified system value group.
static String	getGroupName(int group, Locale locale) Returns the name of the specified system value group.
AS400	getSystem() Returns the system object representing the system on which the system value list exists.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes the PropertyChangeListener.
void	removeVetoableChangeListener(VetoableChangeListener listener) Removes the VetoableChangeListener.
void	setSystem(AS400 system) Sets the system object representing the system on which the system value list exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GROUP_ALC

public static final int GROUP_ALC

Constant indicating the system value's group is *ALC (Allocation).

See Also:

Constant Field Values

GROUP_ALL

public static final int GROUP_ALL

Constant indicating the system value's group is *ALL (All).

See Also:

Constant Field Values

GROUP_DATTIM

public static final int GROUP_DATTIM

Constant indicating the system value's group is *DATTIM (Date and Time).

See Also:

Constant Field Values

GROUP_EDT

public static final int GROUP_EDT

Constant indicating the system value's group is *EDT (Editing).

See Also:

Constant Field Values

GROUP_LIBL

public static final int GROUP_LIBL

Constant indicating the system value's group is *LIBL (Library List).

See Also:

Constant Field Values

GROUP_MSG

public static final int GROUP_MSG

Constant indicating the system value's group is *MSG (Message and Logging).

See Also:

Constant Field Values

GROUP_NET

public static final int GROUP_NET

Constant indicating the system value's group is *NET (Net Attribute).

See Also:

Constant Field Values

GROUP_SEC

public static final int GROUP_SEC

Constant indicating the system value's group is *SEC (Security).

See Also:

Constant Field Values

GROUP_STG

public static final int GROUP_STG

Constant indicating the system value's group is *STG (Storage).

See Also:

Constant Field Values

GROUP_SYSCTL

public static final int GROUP_SYSCTL

Constant indicating the system value's group is *SYSCTL (System control).

See Also:

Constant Field Values

TYPE_ARRAY

public static final int TYPE_ARRAY

Constant indicating the returned system value type is String[].

See Also:

Constant Field Values

TYPE_DATE

public static final int TYPE_DATE

Constant indicating the returned system value type is Date.

See Also:

Constant Field Values

TYPE_DECIMAL

public static final int TYPE_DECIMAL

Constant indicating the returned system value type is BigDecimal.

See Also:

Constant Field Values

TYPE_INTEGER

public static final int TYPE_INTEGER

Constant indicating the returned system value type is Integer.

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

Constant indicating the returned system value type is String.

See Also:

Constant Field Values

Constructor Detail

SystemValueList

public SystemValueList()

Constructs a SystemValueList object. It creates a default SystemValueList object. The system property must be set before attempting a connection.

SystemValueList

public SystemValueList(AS400 system)

Constructs a SystemValueList object. It creates a SystemValueList instance that represents a list of system values on system.

Parameters:

system - The system that contains the system values.

Method Detail

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. The PropertyChangeListener object is added to a list of PropertyChangeListeners managed by this SystemValue. It can be removed with removePropertyChangeListener.

Parameters:

listener - The listener object.

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener listener)

Adds a VetoableChangeListener. The specified VetoableChangeListener's vetoableChange method will be called each time the value of any constrained property is changed.

Parameters:

listener - The listener object.

getGroup

public Vector getGroup(int group)
                throws AS400SecurityException,
                       ErrorCompletingRequestException,
                       InterruptedException,
                       IOException,
                       ObjectDoesNotExistException

Returns a set of SystemValue objects. Returns the system values that belong to the system value group specified by group and sorted by name.

Parameters:

group - The system value group.

Returns:

A Vector of SystemValue objects.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getGroupCount

public static int getGroupCount()

Returns the total number of possible groups.

Returns:

The number of groups.

getGroupDescription

public static String getGroupDescription(int group)

Returns the description for the specified system value group.

Parameters:

group - The system value group.

Returns:

The description of the system value group.

getGroupDescription

public static String getGroupDescription(int group,
                                         Locale locale)

Returns the description for the specified system value group.

Parameters:

group - The system value group.

locale - The Locale used to load the appropriate language.

Returns:

The description of the system value group.

getGroupName

public static String getGroupName(int group)

Returns the name of the specified system value group.

Parameters:

group - The system value group.

Returns:

The name of the system value group.

getGroupName

public static String getGroupName(int group,
                                  Locale locale)

Returns the name of the specified system value group.

Parameters:

group - The system value group.

locale - The Locale used to load the appropriate language.

Returns:

The name of the system value group.

getSystem

public AS400 getSystem()

Returns the system object representing the system on which the system value list exists.

Returns:

The system object representing the system on which the system value list exists. If the system has not been set, null is returned.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes the PropertyChangeListener. If the PropertyChangeListener is not on the list, nothing is done.

Parameters:

listener - The listener object.

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener listener)

Removes the VetoableChangeListener. If the VetoableChangeListener is not on the list, nothing is done.

Parameters:

listener - The listener object.

setSystem

public void setSystem(AS400 system)
               throws PropertyVetoException

Sets the system object representing the system on which the system value list exists.

Parameters:

system - The system object representing the system on which the system value list exists.

Throws:

PropertyVetoException - If any of the registered listeners vetos the property change.