All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.OutputQueue

java.lang.Object
   |
   +----com.ibm.as400.access.PrintObject
           |
           +----com.ibm.as400.access.OutputQueue

public class OutputQueue
extends PrintObject
implements Serializable
The OutputQueue class represents an AS/400 output queue. An instance of this class can be used to manipulate an individual AS/400 output queue (hold, release, clear, and so on). See Output Queue Attributes for valid attributes.


Constructor Index

 o OutputQueue()
Constructs an OutputQueue object.
 o OutputQueue(AS400, String)
Constructs an OutputQueue object.

Method Index

 o addOutputQueueListener(OutputQueueListener)
Adds the specified OutputQueue listener to receive OutputQueue events from this OutputQueue.
 o clear(PrintParameterList)
Clears the output queue on the AS/400.
 o getName()
Returns the name of the output queue.
 o getPath()
Returns the integrated file system pathname of the output queue.
 o hold()
Holds the output queue on the AS/400.
 o release()
Releases a held output queue on the AS/400.
 o removeOutputQueueListener(OutputQueueListener)
Removes the specified OutputQueue listener so that it no longer receives OutputQueue events from this OutputQueue.
 o setPath(String)
Sets the integrated file system pathname of the output queue.

Constructors

 o OutputQueue
 public OutputQueue()
Constructs an OutputQueue object. The AS/400 system and the integrated file system name of the output queue must be set later. This constructor is provided for visual application builders that support JavaBeans. It is not intended for use by application programmers.

See Also:
setSystem, setPath
 o OutputQueue
 public OutputQueue(AS400 system,
                    String queueName)
Constructs an OutputQueue object. It uses the specified system and output queue name that identifies it on that system.

Parameters:
system - The AS/400 on which this output queue exists.
queueName - The integrated file system name of the output queue. The format of the queue string must be in the format of /QSYS.LIB/libname.LIB/queuename.OUTQ.

Methods

 o addOutputQueueListener
 public void addOutputQueueListener(OutputQueueListener listener)
Adds the specified OutputQueue listener to receive OutputQueue events from this OutputQueue.

Parameters:
listener - The OutputQueue listener.
See Also:
removeOutputQueueListener
 o clear
 public void clear(PrintParameterList clearOptions) throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, IOException, InterruptedException, RequestNotSupportedException
Clears the output queue on the AS/400.

Parameters:
clearOptions - A PrintParameterList object that may have any of the following attributes set:
 o getName
 public String getName()
Returns the name of the output queue.

Returns:
The name of the output queue.
 o getPath
 public String getPath()
Returns the integrated file system pathname of the output queue.

Returns:
The integrated file system pathname of the output queue.
 o hold
 public void hold() throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, IOException, InterruptedException, RequestNotSupportedException
Holds the output queue on the AS/400.

Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: InterruptedException
If this thread is interrupted.
Throws: RequestNotSupportedException
If the requested function is not supported because the AS/400 system is not at the correct level.
 o release
 public void release() throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, IOException, InterruptedException, RequestNotSupportedException
Releases a held output queue on the AS/400.

Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: InterruptedException
If this thread is interrupted.
Throws: RequestNotSupportedException
If the requested function is not supported because the AS/400 system is not at the correct level.
 o removeOutputQueueListener
 public void removeOutputQueueListener(OutputQueueListener listener)
Removes the specified OutputQueue listener so that it no longer receives OutputQueue events from this OutputQueue.

Parameters:
listener - The OutputQueue listener.
See Also:
addOutputQueueListener
 o setPath
 public void setPath(String path) throws PropertyVetoException
Sets the integrated file system pathname of the output queue.

Parameters:
path - The integrated file system pathname of the output queue. The format of the queue string must be in the format of /QSYS.LIB/libname.LIB/queuename.OUTQ.
Throws: PropertyVetoException
If the change is vetoed.

All Packages  Class Hierarchy  This Package  Previous  Next  Index