com.ibm.as400.vaccess
Class VMessage

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

All Implemented Interfaces:

java.io.Serializable, VObject

public class VMessage

extends java.lang.Object

implements VObject, java.io.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:

• ErrorEvent
• VObjectEvent
• WorkingEvent

See Also:

AS400Message, Serialized Form

Field Summary

static java.lang.Object	ID_PROPERTY Property identifier for the message ID.
static java.lang.Object	SEVERITY_PROPERTY Property identifier for the message severity.
static java.lang.Object	TEXT_PROPERTY Property identifier for the message text.
static java.lang.Object	TYPE_PROPERTY Property identifier for the message type.

Fields inherited from interface com.ibm.as400.vaccess.VObject

DESCRIPTION_PROPERTY, NAME_PROPERTY

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

ID_PROPERTY

public static final java.lang.Object ID_PROPERTY

Property identifier for the message ID.

SEVERITY_PROPERTY

public static final java.lang.Object SEVERITY_PROPERTY

Property identifier for the message severity.

TEXT_PROPERTY

public static final java.lang.Object TEXT_PROPERTY

Property identifier for the message text.

TYPE_PROPERTY

public static final java.lang.Object TYPE_PROPERTY

Property identifier for the message type.

Method Detail

addErrorListener

public void addErrorListener(ErrorListener listener)

Adds a listener to be notified when an error occurs.

Specified by:

addErrorListener in interface VObject

Parameters:

listener - The listener.

addVObjectListener

public void addVObjectListener(VObjectListener listener)

Adds a listener to be notified when a VObject is changed, created, or deleted.

Specified by:

addVObjectListener in interface VObject

Parameters:

listener - The listener.

addWorkingListener

public void addWorkingListener(WorkingListener listener)

Adds a listener to be notified when work starts and stops on potentially long-running operations.

Specified by:

addWorkingListener in interface VObject

Parameters:

listener - The listener.

getActions

public VAction[] getActions()

Returns the list of actions that can be performed.

Specified by:

getActions in interface VObject

Returns:

Always null. There are no actions.

getDefaultAction

public VAction getDefaultAction()

Returns the default action.

Specified by:

getDefaultAction in interface VObject

Returns:

Always null. There is no default action.

getIcon

public javax.swing.Icon getIcon(int size,
                                boolean open)

Returns the icon.

Specified by:

getIcon in interface VObject

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.

getPropertiesPane

public VPropertiesPane getPropertiesPane()

Returns the properties pane.

Specified by:

getPropertiesPane in interface VObject

Returns:

The properties pane.

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.Object propertyIdentifier)

Returns a property value.

Specified by:

getPropertyValue in interface VObject

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.

getText

public java.lang.String getText()

Returns the text. This is the message ID.

Specified by:

getText in interface VObject

Returns:

The message ID text.

load

public void load()

Loads information about the object from the AS/400.

Specified by:

load in interface VObject

removeErrorListener

public void removeErrorListener(ErrorListener listener)

Removes an error listener.

Specified by:

removeErrorListener in interface VObject

Parameters:

listener - The listener.

removeVObjectListener

public void removeVObjectListener(VObjectListener listener)

Removes a VObjectListener.

Specified by:

removeVObjectListener in interface VObject

Parameters:

listener - The listener.

removeWorkingListener

public void removeWorkingListener(WorkingListener listener)

Removes a working listener.

Specified by:

removeWorkingListener in interface VObject

Parameters:

listener - The listener.

toString

public java.lang.String toString()

Returns the string representation. This is the message ID.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of the message ID.