All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.vaccess.VMessage

java.lang.Object
   |
   +----com.ibm.as400.vaccess.VMessage

public class VMessage
extends Object
implements VObject, Serializable
The VMessage class defines the representation of a message returned from an AS/400 for use in various models and panes in this package.

Most errors are reported as ErrorEvents rather than throwing exceptions. Users should listen for ErrorEvents in order to diagnose and recover from error conditions.

VMessage objects generate the following events:

See Also:
AS400Message

Variable Index

 o ID_PROPERTY
Property identifier for the message ID.
 o SEVERITY_PROPERTY
Property identifier for the message severity.
 o TEXT_PROPERTY
Property identifier for the message text.
 o TYPE_PROPERTY
Property identifier for the message type.

Method Index

 o addErrorListener(ErrorListener)
Adds a listener to be notified when an error occurs.
 o addVObjectListener(VObjectListener)
Adds a listener to be notified when a VObject is changed, created, or deleted.
 o addWorkingListener(WorkingListener)
Adds a listener to be notified when work starts and stops on potentially long-running operations.
 o getActions()
Returns the list of actions that can be performed.
 o getDefaultAction()
Returns the default action.
 o getIcon(int, boolean)
Returns the icon.
 o getPropertiesPane()
Returns the properties pane.
 o getPropertyValue(Object)
Returns a property value.
 o getText()
Returns the text.
 o load()
Loads information about the object from the AS/400.
 o removeErrorListener(ErrorListener)
Removes an error listener.
 o removeVObjectListener(VObjectListener)
Removes a VObjectListener.
 o removeWorkingListener(WorkingListener)
Removes a working listener.
 o toString()
Returns the string representation.

Variables

 o ID_PROPERTY
 public static final Object ID_PROPERTY
Property identifier for the message ID.

 o SEVERITY_PROPERTY
 public static final Object SEVERITY_PROPERTY
Property identifier for the message severity.

 o TEXT_PROPERTY
 public static final Object TEXT_PROPERTY
Property identifier for the message text.

 o TYPE_PROPERTY
 public static final Object TYPE_PROPERTY
Property identifier for the message type.

Methods

 o addErrorListener
 public void addErrorListener(ErrorListener listener)
Adds a listener to be notified when an error occurs.

Parameters:
listener - The listener.
 o addVObjectListener
 public void addVObjectListener(VObjectListener listener)
Adds a listener to be notified when a VObject is changed, created, or deleted.

Parameters:
listener - The listener.
 o 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.
 o getActions
 public VAction[] getActions()
Returns the list of actions that can be performed.

Returns:
Always null. There are no actions.
 o getDefaultAction
 public VAction getDefaultAction()
Returns the default action.

Returns:
Always null. There is no default action.
 o 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.
 o getPropertiesPane
 public VPropertiesPane getPropertiesPane()
Returns the properties pane.

Returns:
The properties pane.
 o getPropertyValue
 public synchronized Object getPropertyValue(Object propertyIdentifier)
Returns a property value.

Parameters:
propertyIdentifier - The property identifier. The choices are
  • NAME_PROPERTY
  • DESCRIPTION_PROPERTY
  • ID_PROPERTY
  • TEXT_PROPERTY
  • TYPE_PROPERTY
  • SEVERITY_PROPERTY
Returns:
The property value, or null if the property identifier is not recognized.
 o getText
 public String getText()
Returns the text. This is the message ID.

Returns:
The message ID text.
 o load
 public void load()
Loads information about the object from the AS/400.

 o removeErrorListener
 public void removeErrorListener(ErrorListener listener)
Removes an error listener.

Parameters:
listener - The listener.
 o removeVObjectListener
 public void removeVObjectListener(VObjectListener listener)
Removes a VObjectListener.

Parameters:
listener - The listener.
 o removeWorkingListener
 public void removeWorkingListener(WorkingListener listener)
Removes a working listener.

Parameters:
listener - The listener.
 o toString
 public String toString()
Returns the string representation. This is the message ID.

Returns:
The string representation of the message ID.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index