|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.access.SystemValueGroup
The SystemValueGroup class represents a user-defined collection of system values and network attributes. It is not as much a container for SystemValue objects as it is a factory for generating collections of SystemValues having certain attributes.
SystemValue
,
SystemValueList
, Serialized FormConstructor Summary | |
SystemValueGroup()
Constructs a SystemValueGroup object. |
|
SystemValueGroup(AS400 system,
java.lang.String groupName,
java.lang.String groupDescription)
Constructs a SystemValueGroup object. |
|
SystemValueGroup(AS400 system,
java.lang.String groupName,
java.lang.String groupDescription,
int group)
Constructs a SystemValueGroup object. |
|
SystemValueGroup(AS400 system,
java.lang.String groupName,
java.lang.String groupDescription,
java.lang.String[] names)
Constructs a SystemValueGroup object. |
Method Summary | |
void |
add(java.lang.String name)
Adds a system value name to this group. |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener. |
void |
addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a VetoableChangeListener. |
boolean |
contains(java.lang.String name)
Determines if a system value name is part of this group. |
java.lang.String |
getGroupDescription()
Returns the user-defined description for this group. |
java.lang.String |
getGroupName()
Returns the user-defined name for this group. |
java.lang.String[] |
getNames()
Returns the system value names that are currently part of this group. |
AS400 |
getSystem()
Returns the system object for this group. |
java.util.Vector |
getSystemValues()
Returns newly-generated SystemValue objects representing the system values in this group. |
static void |
refresh(java.util.Vector systemValues)
Retrieves new values for the SystemValue objects in the Vector. |
boolean |
remove(java.lang.String name)
Removes a system value name from this group. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes the listener from being notified when a bound property changes. |
void |
removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes the listener from being notified when a constrained property changes. |
void |
setGroupDescription(java.lang.String groupDescription)
Sets the user-defined group description for any SystemValue objects generated by this group. |
void |
setGroupName(java.lang.String groupName)
Sets the user-defined group name for any SystemValue objects generated by this group. |
void |
setSystem(AS400 system)
Sets the system for any SystemValue objects generated by this group. |
java.lang.String |
toString()
Returns a String representation of this object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public SystemValueGroup()
setSystem(com.ibm.as400.access.AS400)
public SystemValueGroup(AS400 system, java.lang.String groupName, java.lang.String groupDescription)
system
- The AS/400 that this group of system value names references.groupName
- The user-defined group name to be used.groupDescription
- The user-defined group description to be used.public SystemValueGroup(AS400 system, java.lang.String groupName, java.lang.String groupDescription, java.lang.String[] names)
system
- The AS/400 that this group of system value names references.groupName
- The user-defined group name to be used.groupDescription
- The user-defined group description to be used.names
- The array of system value names to be initially added to this group.public SystemValueGroup(AS400 system, java.lang.String groupName, java.lang.String groupDescription, int group)
system
- The AS/400 that this group of system values references.groupName
- The user-defined group name to be used.groupDescription
- The user-defined group description to be used.group
- The system value group constant indicating the set of system value names to be
initially added to this group. Valid constants are defined in the SystemValueList class.SystemValueList
,
SystemValueList.GROUP_ALL
Method Detail |
public void add(java.lang.String name)
name
- The system value name to be added to this group.contains(java.lang.String)
,
getNames()
,
remove(java.lang.String)
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The PropertyChangeListener.removePropertyChangeListener(java.beans.PropertyChangeListener)
public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The VetoableChangeListener.removeVetoableChangeListener(java.beans.VetoableChangeListener)
public boolean contains(java.lang.String name)
name
- The system value name in question.add(java.lang.String)
,
getNames()
,
remove(java.lang.String)
public java.lang.String getGroupDescription()
setGroupDescription(java.lang.String)
public java.lang.String getGroupName()
setGroupName(java.lang.String)
public java.lang.String[] getNames()
add(java.lang.String)
,
contains(java.lang.String)
,
remove(java.lang.String)
public AS400 getSystem()
public java.util.Vector getSystemValues() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException, java.net.UnknownHostException
If any value in this group is not supported by this group's system, its corresponding SystemValue object will not be returned in the Vector. Therefore, the number of SystemValue objects in the returned Vector may not be the same as the number of system value names represented by this group.
To refresh the values in a Vector of SystemValues, use the refresh() method.
AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.lang.InterruptedException
- If this thread is interrupted.java.io.IOException
- If an error occurs while communicating with the AS/400.ObjectDoesNotExistException
- If the AS/400 object does not exist.java.net.UnknownHostException
- If the AS/400 system cannot be located.refresh(java.util.Vector)
public static void refresh(java.util.Vector systemValues) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException, java.net.UnknownHostException
values
- The group of SystemValue objects to be refreshed.AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.lang.InterruptedException
- If this thread is interrupted.java.io.IOException
- If an error occurs while communicating with the AS/400.ObjectDoesNotExistException
- If the AS/400 object does not exist.java.net.UnknownHostException
- If the AS/400 system cannot be located.SystemValue.clear()
public boolean remove(java.lang.String name)
name
- The system value name to be removed from this group.add(java.lang.String)
,
contains(java.lang.String)
,
getNames()
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The PropertyChangeListener.addPropertyChangeListener(java.beans.PropertyChangeListener)
public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The VetoableChangeListener.addVetoableChangeListener(java.beans.VetoableChangeListener)
public void setGroupDescription(java.lang.String groupDescription) throws java.beans.PropertyVetoException
groupDescription
- The group description.java.beans.PropertyVetoException
- If the change is vetoed.getGroupDescription()
public void setGroupName(java.lang.String groupName) throws java.beans.PropertyVetoException
groupName
- The group name.java.beans.PropertyVetoException
- If the change is vetoed.getGroupName()
public void setSystem(AS400 system) throws java.beans.PropertyVetoException
system
- The AS400 system object.java.beans.PropertyVetoException
- If the change is vetoed.getSystem()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |