All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.vaccess.VOutput

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

public class VOutput
extends Object
implements VObject
The VOutput class defines the representation of a spooled file output 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.

VOutput objects generate the following events:

See Also:
SpooledFile

Variable Index

 o COPIESLEFT_PROPERTY
Property identifier for the number of copies left.
 o DATE_PROPERTY
Property identifier for the date the output was created.
 o FORMTYPE_PROPERTY
Property identifier for the form type.
 o JOB_PROPERTY
Property identifier for the name of the job which produced the output.
 o JOBNUMBER_PROPERTY
Property identifier for the number of the job which produced the output.
 o NUMBER_PROPERTY
Property identifier for the number of the output.
 o OUTPUTNAME_PROPERTY
Property identifier for the output name.
 o OUTPUTQUEUE_PROPERTY
Property identifier for the output queue.
 o OUTPUTQUEUELIB_PROPERTY
Property identifier for the output queue library.
 o PAGESPERCOPY_PROPERTY
Property identifier for the number of pages per copy.
 o PRINTER_PROPERTY
Property identifier for the printer name.
 o PRIORITY_PROPERTY
Property identifier for the priority of the output on the output queue.
 o STATUS_PROPERTY
Property identifier for the status of the output.
 o USER_PROPERTY
Property identifier for the name of the user of the job which produced the output.
 o USERCOMMENT_PROPERTY
Property identifier for the user comment.
 o USERSPECDATA_PROPERTY
Property identifier for the user specified data.

Constructor Index

 o VOutput(VPrinterOutput, SpooledFile)
Constructs a VOutput object.

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 OUTPUTNAME_PROPERTY
 public static final Object OUTPUTNAME_PROPERTY
Property identifier for the output name.

 o USERSPECDATA_PROPERTY
 public static final Object USERSPECDATA_PROPERTY
Property identifier for the user specified data.

 o USER_PROPERTY
 public static final Object USER_PROPERTY
Property identifier for the name of the user of the job which produced the output.

 o STATUS_PROPERTY
 public static final Object STATUS_PROPERTY
Property identifier for the status of the output.

 o PRINTER_PROPERTY
 public static final Object PRINTER_PROPERTY
Property identifier for the printer name.

 o PAGESPERCOPY_PROPERTY
 public static final Object PAGESPERCOPY_PROPERTY
Property identifier for the number of pages per copy.

 o COPIESLEFT_PROPERTY
 public static final Object COPIESLEFT_PROPERTY
Property identifier for the number of copies left.

 o DATE_PROPERTY
 public static final Object DATE_PROPERTY
Property identifier for the date the output was created.

 o FORMTYPE_PROPERTY
 public static final Object FORMTYPE_PROPERTY
Property identifier for the form type.

 o JOB_PROPERTY
 public static final Object JOB_PROPERTY
Property identifier for the name of the job which produced the output.

 o JOBNUMBER_PROPERTY
 public static final Object JOBNUMBER_PROPERTY
Property identifier for the number of the job which produced the output.

 o NUMBER_PROPERTY
 public static final Object NUMBER_PROPERTY
Property identifier for the number of the output.

 o OUTPUTQUEUE_PROPERTY
 public static final Object OUTPUTQUEUE_PROPERTY
Property identifier for the output queue.

 o OUTPUTQUEUELIB_PROPERTY
 public static final Object OUTPUTQUEUELIB_PROPERTY
Property identifier for the output queue library.

 o PRIORITY_PROPERTY
 public static final Object PRIORITY_PROPERTY
Property identifier for the priority of the output on the output queue.

 o USERCOMMENT_PROPERTY
 public static final Object USERCOMMENT_PROPERTY
Property identifier for the user comment.

Constructors

 o VOutput
 public VOutput(VPrinterOutput parent,
                SpooledFile spooledFile)
Constructs a VOutput object.

Parameters:
parent - The parent.
spooledFile - The spooled file.

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 synchronized VAction[] getActions()
Returns the list of actions that can be performed.

Returns:
The 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 the default of 16.
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
  • OUTPUTNAME_PROPERTY
  • USERSPECDATA_PROPERTY
  • USER_PROPERTY
  • STATUS_PROPERTY
  • PRINTER_PROPERTY
  • PAGESPERCOPY_PROPERTY
  • COPIESLEFT_PROPERTY
  • DATE_PROPERTY
  • FORMTYPE_PROPERTY
  • JOB_PROPERTY
  • JOBNUMBER_PROPERTY
  • NUMBER_PROPERTY
  • OUTPUTQUEUE_PROPERTY
  • OUTPUTQUEUELIB_PROPERTY
  • PRIORITY_PROPERTY
  • USERCOMMENT_PROPERTY
Returns:
The property value, or null if the property identifier is not recognized.
 o load
 public synchronized void load()
Loads information about the object from the AS/400.

 o getText
 public String getText()
Returns the text. This is the name of the spooled file (output).

Returns:
The text, which is the name of the spooled file.
 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 spooled file (output) name, number, job user, job number and job name, all separated with blanks.

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index