All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.access.SystemValue
java.lang.Object
|
+----com.ibm.as400.access.SystemValue
- public class SystemValue
- extends Object
- implements Serializable
The SystemValue class represents a system value or network attribute
on the AS/400.
-
SystemValue()
- Constructs a SystemValue object.
-
SystemValue(AS400, String)
- Constructs a SystemValue object.
-
addPropertyChangeListener(PropertyChangeListener)
- Adds a PropertyChangeListener.
-
addSystemValueListener(SystemValueListener)
- Adds a system value listener to receive system value events from this system value.
-
addVetoableChangeListener(VetoableChangeListener)
- Adds the VetoableChangeListener.
-
clear()
- Clears this system value from the cache.
-
getDescription()
- Returns the description for this system value.
-
getGroup()
- Returns the system value group to which this system value belongs.
-
getName()
- Returns the name of this system value.
-
getRelease()
- Returns the supported release version for this system value.
-
getSize()
- Returns the length (in bytes) of this system value's data value component.
-
getSystem()
- Returns the system.
-
getType()
- Returns the type for this system value.
-
getValue()
- Returns the current value of this system value.
-
isReadOnly()
- Indicates if this system value is read only or if it can be
set by the user.
-
removePropertyChangeListener(PropertyChangeListener)
- Removes the PropertyChangeListener from the internal list.
-
removeSystemValueListener(SystemValueListener)
- Removes the SystemValueListener from the internal list.
-
removeVetoableChangeListener(VetoableChangeListener)
- Removes the VetoableChangeListener from the internal list.
-
setName(String)
- Sets the system value name.
-
setSystem(AS400)
- Sets the system.
-
setValue(Object)
- Sets the value for this system value.
SystemValue
public SystemValue()
- Constructs a SystemValue object.
It creates a default SystemValue. The system and name
properties must be set before attempting a connection.
SystemValue
public SystemValue(AS400 system,
String name)
- Constructs a SystemValue object.
It creates a SystemValue instance that represents the system value
name on system.
- Parameters:
- system - The AS/400 that this system value references.
- name - The name of the system value.
addSystemValueListener
public void addSystemValueListener(SystemValueListener listener)
- Adds a system value listener to receive system value events from this system value.
- Parameters:
- listener - The system value listener.
- See Also:
- removeSystemValueListener
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
- Adds a PropertyChangeListener.
- Parameters:
- listener - The PropertyChangeListener.
- See Also:
- removePropertyChangeListener
addVetoableChangeListener
public void addVetoableChangeListener(VetoableChangeListener listener)
- Adds the VetoableChangeListener.
- Parameters:
- listener - The VetoableChangeListener.
- See Also:
- removeVetoableChangeListener
clear
public void clear()
- Clears this system value from the cache.
The next time a getValue() is performed on this system value, the value
will be retrieved from the AS/400 instead of from the cache.
getDescription
public String getDescription()
- Returns the description for this system value.
- Returns:
- The description for the system value.
getGroup
public int getGroup()
- Returns the system value group to which this system value belongs.
Possible values are:
- GROUP_ALC
- GROUP_ALL
- GROUP_DATTIM
- GROUP_EDT
- GROUP_LIBL
- GROUP_MSG
- GROUP_NET
- GROUP_SEC
- GROUP_STG
- GROUP_SYSCTL
- Returns:
- The system value group.
- See Also:
- SystemValueList
getName
public String getName()
- Returns the name of this system value.
- Returns:
- The name of the system value.
getRelease
public int getRelease()
- Returns the supported release version for this system value.
The returned value is the earliest version of OS/400 under which the
system value is supported. If the system value is supported in a release
prior to V4R2, then V4R2 is returned.
- Returns:
- The release.
- See Also:
- generateVRM
getSize
public int getSize()
- Returns the length (in bytes) of this system value's data value component.
For system values that are of type TYPE_ARRAY, this method returns the
total size of the data value.
- Returns:
- The size.
getSystem
public AS400 getSystem()
- Returns the system.
- Returns:
- The AS/400.
getType
public int getType()
- Returns the type for this system value.
Possible values are:
- TYPE_ARRAY - The data contained by this system value is a String[] object.
- TYPE_DATE - The data contained by this system value is a Date object.
- TYPE_DECIMAL - The data contained by this system value is a BigDecimal object.
- TYPE_INTEGER - The data contained by this system value is an Integer object.
- TYPE_STRING - The data contained by this system value is a String object.
- Returns:
- The return type.
- See Also:
- SystemValueList
getValue
public Object getValue() throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, PropertyVetoException, RequestNotSupportedException, UnknownHostException
- Returns the current value of this system value.
- Returns:
- The data.
- 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: PropertyVetoException
- If the change is vetoed.
- Throws: RequestNotSupportedException
- If the release level of the AS/400 does not support the system value.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
isReadOnly
public boolean isReadOnly()
- Indicates if this system value is read only or if it can be
set by the user.
- Returns:
- true if the system value is read only; false otherwise.
removeSystemValueListener
public void removeSystemValueListener(SystemValueListener listener)
- Removes the SystemValueListener from the internal list.
If the SystemValueListener is not on the list, nothing is done.
- Parameters:
- listener - The system value listener.
- See Also:
- addSystemValueListener
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
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
setName
public void setName(String name) throws PropertyVetoException
- Sets the system value name.
- Parameters:
- name - The system value.
- Throws: PropertyVetoException
- If the change is vetoed.
setSystem
public void setSystem(AS400 system) throws PropertyVetoException
- Sets the system.
- Parameters:
- system - The AS/400.
- Throws: PropertyVetoException
- If the change is vetoed.
setValue
public void setValue(Object value) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, PropertyVetoException, RequestNotSupportedException, UnknownHostException
- Sets the value for this system value.
- Parameters:
- value - The data.
- 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: PropertyVetoException
- If the change is vetoed.
- Throws: RequestNotSupportedException
- If the release level of the AS/400 does not support the system value.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
All Packages Class Hierarchy This Package Previous Next Index