All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.vaccess.VPrinterOutput

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

public class VPrinterOutput
extends Object
implements VNode, Serializable
The VPrinterOutput class defines the representation of a list of spooled files on an AS/400 for use in various models and panes in this package.

A VPrinterOutput object has no children. Its details children are the spooled files (VOutput objects) in this list.

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.

VPrinterOutput objects generate the following events:

See Also:
SpooledFileList

Constructor Index

 o VPrinterOutput()
Constructs a VPrinterOutput object.
 o VPrinterOutput(AS400)
Constructs a VPrinterOutput object.
 o VPrinterOutput(VNode, AS400)
Constructs a VPrinterOutput 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 getFormTypeFilter()
Returns the form type filter for the list.
 o getIcon(int, boolean)
Returns the icon.
 o getIndex(TreeNode)
Returns the index of the specified child.
 o getParent()
Returns the parent node.
 o getPropertiesPane()
Returns the properties pane.
 o getPropertyValue(Object)
Returns a property value.
 o getQueueFilter()
Returns the output queue list filter.
 o getSystem()
Returns the AS/400 on which the output resides.
 o getText()
Returns the text.
 o getUserDataFilter()
Returns the user data list filter.
 o getUserFilter()
Returns the user ID list filter.
 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 setFormTypeFilter(String)
Sets the form type filter for the list.
 o setQueueFilter(String)
Sets the output queue filter.
 o setSystem(AS400)
Sets the AS/400 on which the output resides.
 o setUserDataFilter(String)
Sets the user data list filter.
 o setUserFilter(String)
Sets the user ID list filter.
 o sortDetailsChildren(Object[], boolean[])
Sorts the children for the details.
 o toString()
Returns the string representation.

Constructors

 o VPrinterOutput
 public VPrinterOutput()
Constructs a VPrinterOutput object.

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

Parameters:
system - The AS/400 on which the output resides.
 o VPrinterOutput
 public VPrinterOutput(VNode parent,
                       AS400 system)
Constructs a VPrinterOutput object.

Parameters:
parent - The parent.
system - The AS/400 on which the output resides.

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

Returns:
An empty enumeration.
 o getActions
 public VAction[] getActions()
Returns the list of actions that can be performed.

Returns:
Always null. There are no 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 synchronized VObject getDetailsChildAt(int index)
Returns the child for the details at the specified index. The details child is a spooled file (VOutput object) in this list.

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. The details children are the spooled files (VOutput objects) in this list.

Returns:
The number of children for 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. The details children are the spooled files (VOutput objects) in this list.

Returns:
The details column model.
 o getDetailsIndex
 public synchronized int getDetailsIndex(VObject child)
Returns the index of the specified child for the details. The details child is a spooled file (VOutput object) in this list.

Parameters:
detailsChild - The details child.
Returns:
The index, or -1 if the child is not found in the details.
 o getFormTypeFilter
 public String getFormTypeFilter()
Returns the form type filter for the list. The filter contains the form type a spooled file must be to be included in the list.

Returns:
The form type filter.
 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 the default of 16.
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 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 or DESCRIPTION_PROPERTY.
Returns:
The property value, or null if the property identifier is not recognized.
 o getQueueFilter
 public String getQueueFilter()
Returns the output queue list filter.

Returns:
The output queue filter.
 o getSystem
 public AS400 getSystem()
Returns the AS/400 on which the output resides.

Returns:
The AS/400 on which the output resides.
 o getText
 public String getText()
Returns the text. This is a constant string which identifies this object as a list of printer output.

Returns:
The text.
 o getUserDataFilter
 public String getUserDataFilter()
Returns the user data list filter.

Returns:
The user data filter.
 o getUserFilter
 public String getUserFilter()
Returns the user ID list filter.

Returns:
The user ID filter.
 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 true.
 o load
 public synchronized 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 setFormTypeFilter
 public void setFormTypeFilter(String formTypeFilter) throws PropertyVetoException
Sets the form type filter for the list. A call to load() must be done after calling this funtion inorder to update the details children.

Parameters:
formTypeFilter - The form type the spooled file must be to be included in the list. It cannot be greater than 10 characters. The value can be any specific value or any of these special values:
  • *ALL - Spooled files with any form type will be included in the list.
  • *STD - Spooled files with the form type *STD will be included in the list.
The default is *ALL.
Throws: PropertyVetoException
If the change is vetoed.
 o setQueueFilter
 public void setQueueFilter(String queueFilter) throws PropertyVetoException
Sets the output queue filter. A call to load() must be done after calling this funtion inorder to update the details children.

Parameters:
queueFilter - The library and output queues on which to list spooled files. The format of the queueFilter string must be in the format of /QSYS.LIB/libname.LIB/queuename.OUTQ where
libname is the library name that contains the queues to search. It can be a specific name or one of these special values:
  • %LIBL% - The server job's library list.
  • %ALL% - All libraries are searched. This value is only valid if the queuename is %ALL%.
queuename is the name of the output queues to search. It can be a specific name or the special value %ALL%. If it is %ALL%, then the libname must also be %ALL%.
Throws: PropertyVetoException
If the change is vetoed.
 o setSystem
 public void setSystem(AS400 system) throws PropertyVetoException
Sets the AS/400 on which the output resides. A call to load() must be done after calling this funtion inorder to update the details children.

Parameters:
system - The AS/400 on which the output resides.
Throws: PropertyVetoException
If the change is vetoed.
 o setUserDataFilter
 public void setUserDataFilter(String userDataFilter) throws PropertyVetoException
Sets the user data list filter. A call to load() must be done after calling this funtion inorder to update the details children.

Parameters:
userDataFilter - The user data the spooled file must have for it to be included in the list. The value can be any specific value or the special value *ALL. The value cannot be greater than 10 characters. The default is *ALL.
Throws: PropertyVetoException
If the change is vetoed.
 o setUserFilter
 public void setUserFilter(String userFilter) throws PropertyVetoException
Sets the user ID list filter. A call to load() must be done after calling this funtion inorder to update the details children.

Parameters:
userFilter - The user or users for which to list spooled files. The value cannot be greater than 10 characters. The value can be any specific user ID or any of these special values:
  • *ALL - Spooled files created by all users will be included in the list.
  • *CURRENT - Spooled files created by the current user only will be in the list.
The default is *CURRENT.
Throws: PropertyVetoException
If the change is vetoed.
 o sortDetailsChildren
 public synchronized void sortDetailsChildren(Object propertyIdentifiers[],
                                              boolean orders[])
Sorts the children for the details. The propertyIdentifer[0], orders[0] combination is used to do the sort. If the values are equal, propertyIdentifier[1], orders[1] is used to break the tie, and so forth.

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. This is a constant string which identifies this object as a list of printer output.

Returns:
The string representation.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index