All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.vaccess.VMessageQueue

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

public class VMessageQueue
extends Object
implements VNode, Serializable
The VMessageQueue class defines the representation of a message queue on an AS/400 for use in various models and panes in this package. You must explicitly call load() to load the information from the AS/400.

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

VMessageQueue objects generate the following events:

See Also:
MessageQueue

Constructor Index

 o VMessageQueue()
Constructs a VMessageQueue object.
 o VMessageQueue(AS400)
Constructs a VMessageQueue object.
 o VMessageQueue(AS400, String)
Constructs a VMessageQueue object.
 o VMessageQueue(VNode, AS400, String)
Constructs a VMessageQueue object.

Method Index

 o addErrorListener(ErrorListener)
Adds a listener to be notified when an error occurs.
 o addPropertyChangeListener(PropertyChangeListener)
Adds a listener to be notified when the value of any bound property changes.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a listener to be notified when the value of any constrained property changes.
 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 children()
Returns the children of the node.
 o getActions()
Returns the list of actions that can be performed.
 o getAllowsChildren()
Indiciates if the node allows children.
 o getChildAt(int)
Returns the child node at the specified index.
 o getChildCount()
Returns the number of children.
 o getDefaultAction()
Returns the default action.
 o getDetailsChildAt(int)
Returns the child for the details at the specified index.
 o getDetailsChildCount()
Returns the number of children for the details.
 o getDetailsColumnModel()
Returns the table column model to use in the details when representing the children.
 o getDetailsIndex(VObject)
Returns the index of the specified child for the details.
 o getIcon(int, boolean)
Returns the icon.
 o getIndex(TreeNode)
Returns the index of the specified child.
 o getParent()
Returns the parent node.
 o getPath()
Returns the fully qualified integrated file system path name of the message queue.
 o getPropertiesPane()
Returns the properties pane.
 o getPropertyValue(Object)
Returns a property value.
 o getSelection()
Returns the selection.
 o getSeverity()
Returns the severity.
 o getSystem()
Returns the AS/400 on which the message queue exists.
 o getText()
Returns the name of the message queue.
 o isLeaf()
Indicates if the node is a leaf.
 o isSortable()
Indicates if the details children are sortable.
 o load()
Loads information about the object from the AS/400.
 o removeErrorListener(ErrorListener)
Removes an error listener.
 o removePropertyChangeListener(PropertyChangeListener)
Removes a property change listener.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes a vetoable change listener.
 o removeVObjectListener(VObjectListener)
Removes a VObjectListener.
 o removeWorkingListener(WorkingListener)
Removes a working listener.
 o setPath(String)
Sets the fully qualified integrated file system path name of the message queue.
 o setSelection(String)
Sets the selection.
 o setSeverity(int)
Sets the severity.
 o setSystem(AS400)
Sets the AS/400 on which the message queue resides.
 o sortDetailsChildren(Object[], boolean[])
Sorts the children for the details.
 o toString()
Returns the string representation of the description.

Constructors

 o VMessageQueue
 public VMessageQueue()
Constructs a VMessageQueue object.

 o VMessageQueue
 public VMessageQueue(AS400 system)
Constructs a VMessageQueue object.

Parameters:
system - The AS/400 on which the message queue resides.
 o VMessageQueue
 public VMessageQueue(AS400 system,
                      String path)
Constructs a VMessageQueue object.

Parameters:
system - The AS/400 on which the message queue resides.
path - The fully qualified integrated file system path name of the message queue. The path must be in the format of /QSYS.LIB/libname.LIB/messageQueue.MSGQ.
 o VMessageQueue
 public VMessageQueue(VNode parent,
                      AS400 system,
                      String path)
Constructs a VMessageQueue object.

Parameters:
parent - The parent.
system - The AS/400 on which the message queue resides.
path - The fully qualified integrated file system path name of the message queue. The path must be in the format of /QSYS.LIB/libname.LIB/messageQueue.MSGQ.

Methods

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

Parameters:
listener - The listener.
 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes.

Parameters:
listener - The listener.
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes.

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 children
 public Enumeration children()
Returns the children of the node.

Returns:
The children.
 o getActions
 public VAction[] getActions()
Returns the list of actions that can be performed.

Returns:
The actions.
 o getAllowsChildren
 public boolean getAllowsChildren()
Indiciates if the node allows children.

Returns:
Always false.
 o getChildAt
 public TreeNode getChildAt(int index)
Returns the child node at the specified index.

Parameters:
index - The index.
Returns:
Always null.
 o getChildCount
 public int getChildCount()
Returns the number of children.

Returns:
Always 0.
 o getDefaultAction
 public VAction getDefaultAction()
Returns the default action.

Returns:
Always null. There is no default action.
 o getDetailsChildAt
 public VObject getDetailsChildAt(int index)
Returns the child for the details at the specified index.

Parameters:
index - The index.
Returns:
The child, or null if the index is not valid.
 o getDetailsChildCount
 public synchronized int getDetailsChildCount()
Returns the number of children for the details.

Returns:
The number of children for the details.
 o getDetailsIndex
 public synchronized int getDetailsIndex(VObject detailsChild)
Returns the index of the specified child for the details.

Parameters:
detailsChild - The details child.
Returns:
The index, or -1 if the child is not found in the details.
 o getDetailsColumnModel
 public TableColumnModel getDetailsColumnModel()
Returns the table column model to use in the details when representing the children. This column model describes the details values for the children.

Returns:
The details column model.
 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 getIndex
 public int getIndex(TreeNode child)
Returns the index of the specified child.

Parameters:
child - The child.
Returns:
Always -1.
 o getParent
 public TreeNode getParent()
Returns the parent node.

Returns:
The parent node, or null if there is no parent.
 o getPath
 public String getPath()
Returns the fully qualified integrated file system path name of the message queue.

Returns:
The fully qualified integrated file system path name of the message queue.
See Also:
getPath
 o getPropertiesPane
 public VPropertiesPane getPropertiesPane()
Returns the properties pane.

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

Parameters:
propertyIdentifier - The property identifier. The choices are NAME_PROPERTY or DESCRIPTION_PROPERTY.
Returns:
The property value, or null if the property identifier is not recognized.
 o getSelection
 public String getSelection()
Returns the selection.

Returns:
The selection.
See Also:
getSelection
 o getSeverity
 public int getSeverity()
Returns the severity.

Returns:
The severity.
See Also:
getSeverity
 o getSystem
 public AS400 getSystem()
Returns the AS/400 on which the message queue exists.

Returns:
The AS/400 on which the message queue exists.
See Also:
getSystem
 o getText
 public String getText()
Returns the name of the message queue.

Returns:
The name of the message queue.
 o isLeaf
 public boolean isLeaf()
Indicates if the node is a leaf.

Returns:
Always true.
 o isSortable
 public boolean isSortable()
Indicates if the details children are sortable.

Returns:
Always false.
 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 removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a property change listener.

Parameters:
listener - The listener.
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes a vetoable change 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 setPath
 public void setPath(String path) throws PropertyVetoException
Sets the fully qualified integrated file system path name of the message queue. This does not take effect the data until load() is done.

Parameters:
path - The fully qualified integrated file system path name of the message queue. The path must be in the format of /QSYS.LIB/libname.LIB/messageQueue.MSGQ. The library and queue name must each be 10 characters or less.
Throws: PropertyVetoException
If the change is vetoed.
See Also:
setPath
 o setSelection
 public void setSelection(String selection) throws PropertyVetoException
Sets the selection.

Parameters:
selection - The selection.
Throws: PropertyVetoException
If the change is vetoed.
See Also:
setSelection
 o setSeverity
 public void setSeverity(int severity) throws PropertyVetoException
Sets the severity.

Parameters:
severity - The severity.
Throws: PropertyVetoException
If the change is vetoed.
See Also:
setSeverity
 o setSystem
 public void setSystem(AS400 system) throws PropertyVetoException
Sets the AS/400 on which the message queue resides.

Parameters:
system - The AS/400 on which the message queue resides.
Throws: PropertyVetoException
If the change is vetoed.
See Also:
setSystem
 o sortDetailsChildren
 public void sortDetailsChildren(Object propertyIdentifiers[],
                                 boolean orders[])
Sorts the children for the details. Since sorting is not supported, this method does nothing.

Parameters:
propertyIdentifiers - The property identifiers.
orders - The sort orders for each property identifier. true for ascending order; false for descending order.
 o toString
 public String toString()
Returns the string representation of the description.

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index