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:
- ErrorEvent
- VObjectEvent
- WorkingEvent
- See Also:
- SpooledFile
-
COPIESLEFT_PROPERTY
- Property identifier for the number of copies left.
-
DATE_PROPERTY
- Property identifier for the date the output was created.
-
FORMTYPE_PROPERTY
- Property identifier for the form type.
-
JOB_PROPERTY
- Property identifier for the name of the job which produced the output.
-
JOBNUMBER_PROPERTY
- Property identifier for the number of the job which produced the output.
-
NUMBER_PROPERTY
- Property identifier for the number of the output.
-
OUTPUTNAME_PROPERTY
- Property identifier for the output name.
-
OUTPUTQUEUE_PROPERTY
- Property identifier for the output queue.
-
OUTPUTQUEUELIB_PROPERTY
- Property identifier for the output queue library.
-
PAGESPERCOPY_PROPERTY
- Property identifier for the number of pages per copy.
-
PRINTER_PROPERTY
- Property identifier for the printer name.
-
PRIORITY_PROPERTY
- Property identifier for the priority of the output on the output queue.
-
STATUS_PROPERTY
- Property identifier for the status of the output.
-
USER_PROPERTY
- Property identifier for the name of the user of the job which produced the output.
-
USERCOMMENT_PROPERTY
- Property identifier for the user comment.
-
USERSPECDATA_PROPERTY
- Property identifier for the user specified data.
-
VOutput(VPrinterOutput, SpooledFile)
- Constructs a VOutput object.
-
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 list of 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.
-
getSpooledFile()
- Returns the spooled file.
-
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.
OUTPUTNAME_PROPERTY
public static final Object OUTPUTNAME_PROPERTY
- Property identifier for the output name.
USERSPECDATA_PROPERTY
public static final Object USERSPECDATA_PROPERTY
- Property identifier for the user specified data.
USER_PROPERTY
public static final Object USER_PROPERTY
- Property identifier for the name of the user of the job which produced the output.
STATUS_PROPERTY
public static final Object STATUS_PROPERTY
- Property identifier for the status of the output.
PRINTER_PROPERTY
public static final Object PRINTER_PROPERTY
- Property identifier for the printer name.
PAGESPERCOPY_PROPERTY
public static final Object PAGESPERCOPY_PROPERTY
- Property identifier for the number of pages per copy.
COPIESLEFT_PROPERTY
public static final Object COPIESLEFT_PROPERTY
- Property identifier for the number of copies left.
DATE_PROPERTY
public static final Object DATE_PROPERTY
- Property identifier for the date the output was created.
FORMTYPE_PROPERTY
public static final Object FORMTYPE_PROPERTY
- Property identifier for the form type.
JOB_PROPERTY
public static final Object JOB_PROPERTY
- Property identifier for the name of the job which produced the output.
JOBNUMBER_PROPERTY
public static final Object JOBNUMBER_PROPERTY
- Property identifier for the number of the job which produced the output.
NUMBER_PROPERTY
public static final Object NUMBER_PROPERTY
- Property identifier for the number of the output.
OUTPUTQUEUE_PROPERTY
public static final Object OUTPUTQUEUE_PROPERTY
- Property identifier for the output queue.
OUTPUTQUEUELIB_PROPERTY
public static final Object OUTPUTQUEUELIB_PROPERTY
- Property identifier for the output queue library.
PRIORITY_PROPERTY
public static final Object PRIORITY_PROPERTY
- Property identifier for the priority of the output on the output queue.
USERCOMMENT_PROPERTY
public static final Object USERCOMMENT_PROPERTY
- Property identifier for the user comment.
VOutput
public VOutput(VPrinterOutput parent,
SpooledFile spooledFile)
- Constructs a VOutput object.
- Parameters:
- parent - The parent.
- spooledFile - The spooled file.
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 synchronized VAction[] getActions()
- Returns the list of actions that can be performed.
- reply
- hold
- release
- print next
- send
- move
- delete
- view
- Returns:
- The actions.
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 the default of 16.
- open - This parameter has no effect.
- Returns:
- The icon.
getPropertiesPane
public VPropertiesPane getPropertiesPane()
- Returns the properties pane.
- Returns:
- The properties pane.
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.
getSpooledFile
public SpooledFile getSpooledFile()
- Returns the spooled file.
- Returns:
- The spooled file.
load
public synchronized void load()
- Loads information about the object from the AS/400.
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.
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 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