All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.vaccess.VQueuedMessage
java.lang.Object
|
+----com.ibm.as400.vaccess.VQueuedMessage
- public class VQueuedMessage
- extends Object
- implements VObject, Serializable
The VQueuedMessage class defines the representation of
a queued message on 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.
VQueuedMessage objects generate the following events:
- ErrorEvent
- VObjectEvent
- WorkingEvent
-
DATE_PROPERTY
- Property identifier for the date.
-
FROM_JOB_NUMBER_PROPERTY
- Property identifier for the from job number.
-
FROM_JOB_PROPERTY
- Property identifier for the from job name.
-
FROM_PROGRAM_PROPERTY
- Property identifier for the from program.
-
FROM_USER_PROPERTY
- Property identifier for the from user name.
-
ID_PROPERTY
- Property identifier for the message ID.
-
MESSAGE_QUEUE_PROPERTY
- Property identifier for the message queue.
-
SEVERITY_PROPERTY
- Property identifier for the message severity.
-
TEXT_PROPERTY
- Property identifier for the message text.
-
TYPE_PROPERTY
- Property identifier for the message type.
-
addErrorListener(ErrorListener)
- Adds a listener to be notified when an error occurs.
-
addVObjectListener(VObjectListener)
- Adds a listener to be notified when a VObject is changed,
created, or deleted.
-
addWorkingListener(WorkingListener)
- Adds a listener to be notified when work starts and stops
on potentially long-running operations.
-
getActions()
- Returns the actions that can be performed.
-
getDefaultAction()
- Returns the default action.
-
getIcon(int, boolean)
- Returns the icon.
-
getPropertiesPane()
- Returns the properties pane.
-
getPropertyValue(Object)
- Returns a property value.
-
getText()
- Returns the text.
-
load()
- Loads information about the object from the AS/400.
-
removeErrorListener(ErrorListener)
- Removes an error listener.
-
removeVObjectListener(VObjectListener)
- Removes a VObjectListener.
-
removeWorkingListener(WorkingListener)
- Removes a working listener.
-
toString()
- Returns the string representation.
DATE_PROPERTY
public static final Object DATE_PROPERTY
- Property identifier for the date.
FROM_JOB_PROPERTY
public static final Object FROM_JOB_PROPERTY
- Property identifier for the from job name.
FROM_JOB_NUMBER_PROPERTY
public static final Object FROM_JOB_NUMBER_PROPERTY
- Property identifier for the from job number.
FROM_PROGRAM_PROPERTY
public static final Object FROM_PROGRAM_PROPERTY
- Property identifier for the from program.
FROM_USER_PROPERTY
public static final Object FROM_USER_PROPERTY
- Property identifier for the from user name.
ID_PROPERTY
public static final Object ID_PROPERTY
- Property identifier for the message ID.
MESSAGE_QUEUE_PROPERTY
public static final Object MESSAGE_QUEUE_PROPERTY
- Property identifier for the message queue.
SEVERITY_PROPERTY
public static final Object SEVERITY_PROPERTY
- Property identifier for the message severity.
TEXT_PROPERTY
public static final Object TEXT_PROPERTY
- Property identifier for the message text.
TYPE_PROPERTY
public static final Object TYPE_PROPERTY
- Property identifier for the message type.
addErrorListener
public void addErrorListener(ErrorListener listener)
- Adds a listener to be notified when an error occurs.
- Parameters:
- listener - The listener.
addVObjectListener
public void addVObjectListener(VObjectListener listener)
- Adds a listener to be notified when a VObject is changed,
created, or deleted.
- 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.
- Parameters:
- listener - The listener.
getActions
public VAction[] getActions()
- Returns the actions that can be performed.
- Returns:
- The actions that can be performed.
getDefaultAction
public VAction getDefaultAction()
- Returns the default action.
- Returns:
- Always null. There is no default action.
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.
getPropertiesPane
public VPropertiesPane getPropertiesPane()
- Returns the properties pane.
- Returns:
- The properties pane.
getPropertyValue
public Object getPropertyValue(Object propertyIdentifier)
- Returns a property value.
- Parameters:
- propertyIdentifier - The property identifier. The choices are:
- NAME_PROPERTY
- DESCRIPTION_PROPERTY
- ID_PROPERTY
- TEXT_PROPERTY
- SEVERITY_PROPERTY
- TYPE_PROPERTY
- DATE_PROPERTY
- FROM_JOB_PROPERTY
- FROM_USER_PROPERTY
- FROM_JOB_NUMBER_PROPERTY
- FROM_PROGRAM_PROPERTY
- MESSAGE_QUEUE_PROPERTY
- Returns:
- The property value, or null if the
property identifier is not recognized.
getText
public String getText()
- Returns the text. This is the message ID.
- Returns:
- The message ID text.
load
public void load()
- Loads information about the object from the AS/400.
removeErrorListener
public void removeErrorListener(ErrorListener listener)
- Removes an error listener.
- Parameters:
- listener - The listener.
removeVObjectListener
public void removeVObjectListener(VObjectListener listener)
- Removes a VObjectListener.
- Parameters:
- listener - The listener.
removeWorkingListener
public void removeWorkingListener(WorkingListener listener)
- Removes a working listener.
- Parameters:
- listener - The listener.
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